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 Category	Description	Example
Crop Types	The 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
Varieties	Branded seeds for a particular crop type	P9714R a Corn variety sold by Pioneer
Chemicals	Crop Protection products like Herbicides, Insecticides, Fungicides, Growth Stabilizers and Additives	Round Up, an Herbicide sold by Bayer
Fertilizers	Crop Nutrients like Fertilizers and Manure	Ammonium Sulfate 21-0-0, a fertilizer sold by Simplot
Tank Mixes	A 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.

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.

Active Ingredients Endpoints

These endpoints will allow you to view the list of available active ingredients.

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.

Varieties Endpoints

View varieties for an org

GET

/organizations/{organizationId}/varieties

This endpoint will retrieve a collection of varieties for the specified org.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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	query

Parameter

Type

Description & Example

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

query

Response Details

Field	Type	Description & 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	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
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. Example: false
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceId^DEPRECATED	string	product id of the reference variety Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
createdTime^DEPRECATED	string	product created time Example: 2017-03-21T21:12:53.865Z
modifiedTime^DEPRECATED	string	product modified time Example: 2018-04-06T15:12:52.910Z
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label.
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
docType	string	Type of document for this product. Example: 24(c) Registration
productErid	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

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/654321/varieties?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/organizations/654321/varieties?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 20,
  "values": [
    {
      "@type": "Variety",
      "id": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
      "name": "1299",
      "category": "VARIETY",
      "cropName": "SOYBEANS",
      "companyName": "Curry Seed",
      "createdTime": "2024-12-04T07:52:51.267Z",
      "modifiedTime": "2024-12-06T07:52:51.267Z",
      "referenceGuid": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
      "referenceId": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
      "archived": false,
      "documentsList": [
        {
          "@type": "Document",
          "erid": "08e930ee-4c31-41b6-b57e-8c0a8e1284a4",
          "docType": "24(c) Registration",
          "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
          "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
          "fileName": "ld7OD026.pdf",
          "expirationDate": "2017-03-22"
        }
      ],
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/356823/varieties/cf09acfc-9196-4dbb-9b38-1be02673c5ff"
        }
      ]
    },
    {
      "@type": "Variety",
      "id": "1a63a1fe-b00f-403f-81f7-c157e0234cc4",
      "name": "2C788A SXRA COR",
      "category": "VARIETY",
      "cropName": "CORN_WET",
      "companyName": "MYCOGEN SEEDS",
      "createdTime": "2024-12-04T07:52:51.267Z",
      "referenceGuid": "1a63a1fe-b00f-403f-81f7-c157e0234cc4",
      "referenceId": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
      "archived": false,
      "documentsList": [
        {
          "@type": "Document",
          "erid": "4cb1e8c0-e801-4f19-b674-6362246be920",
          "docType": "24(c) Registration",
          "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
          "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
          "fileName": "ld7OD026.pdf",
          "expirationDate": "2017-03-22"
        }
      ],
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/356823/varieties/c3a58145-acfc-4b73-bc1d-0d442697e053"
        }
      ]
    },
    {
      "@type": "Variety",
      "id": "bd489040-c98b-403e-ac6e-ab2d7d4ac3fa",
      "name": "33H83",
      "category": "VARIETY",
      "cropName": "CORN_WET",
      "companyName": "Pioneer",
      "createdTime": "2024-12-04T07:52:51.267Z",
      "referenceGuid": "bd489040-c98b-403e-ac6e-ab2d7d4ac3fa",
      "referenceId": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
      "archived": false,
      "documentsList": [
        {
          "@type": "Document",
          "erid": "cf09acfc-9196-4dbb-9b38-1be02673c5ff",
          "docType": "24(c) Registration",
          "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
          "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
          "fileName": "ld7OD026.pdf",
          "expirationDate": "2017-03-22"
        }
      ],
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/356823/varieties/b006726b-38a0-44a6-b723-a966c68170b6"
        }
      ]
    }
  ]
}

Add a variety

POST

/organizations/{organizationId}/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: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
@type	---	--- Example: Variety
name Required	string	The common name of the variety. Example: S73-Z5 - 50lb bag
cropName Required	string	The identifier of the crop type that this variety is associated with (see the Crop Types API). Example: SOYBEANS
companyName Required	string	The brand of the variety. Example: NK
category	string	--- Example: VARIETY Allowed Values: VARIETY
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. Example: false
createdTime^DEPRECATED	string	product created time Example: 2017-03-21T21:12:53.865Z
modifiedTime^DEPRECATED	string	product modified time Example: 2018-04-06T15:12:52.910Z

Sample Request [JSON]

{
  "name": "2C788A SXRA COR",
  "companyName": "MYCOGEN SEEDS",
  "cropName": "CORN_WET",
  "category": "VARIETY",
  "archived": false,
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z"
}

Sample Response

201 Created
Location: https://sandboxapi.deere.com/platform/organizations/654321/varieties/8e1e0920-1265-4066-8067-8ce2ce5012b2

View a specific variety

GET

/organizations/{organizationId}/varieties/{erid}

This endpoint will return the variety with the specified erid.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path
embed	array	An embeddable list of properties which are optional by default. Allowed Values: documents	query

Response Details

Field	Type	Description & 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	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
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. Example: false
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceId^DEPRECATED	string	product id of the reference variety Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
createdTime^DEPRECATED	string	product created time Example: 2017-03-21T21:12:53.865Z
modifiedTime^DEPRECATED	string	product modified time Example: 2018-04-06T15:12:52.910Z
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label.
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
docType	string	Type of document for this product. Example: 24(c) Registration
productErid	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

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
  "@type": "Variety",
  "id": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
  "name": "1299",
  "cropName": "SOYBEANS",
  "companyName": "Curry Seed",
  "archived": false,
  "category": "VARIETY",
  "referenceGuid": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
  "referenceId": "8e1e0920-1265-4066-8067-8ce2ce5012b2",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2017-03-22T21:12:53.870Z",
  "documentsList": [
    {
      "@type": "Document",
      "erid": "cf09acfc-9196-4dbb-9b38-1be02673c5ff",
      "docType": "24(c) Registration",
      "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
      "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
      "fileName": "ld7OD026.pdf",
      "expirationDate": "2017-03-22"
    }
  ],
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/356823/varieties/cf09acfc-9196-4dbb-9b38-1be02673c5ff"
    }
  ]
}

Update a single variety

PUT

/organizations/{organizationId}/varieties/{erid}

This endpoint allows the custom variety to be renamed, made active/archived, or associated to a different manufacturer or crop type.

OAuth Scope Required: eq2

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{organizationId}/varieties/{erid}

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path

Request Details

Field	Type	Description & Example
@type	---	--- Example: Variety
name Required	string	The common name of the variety. Example: S73-Z5 - 50lb bag
cropName Required	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 Required	string	The brand of the variety. Example: NK
category	string	--- Example: VARIETY Allowed Values: VARIETY
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. Example: false
createdTime^DEPRECATED	string	product created time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modified time Example: 2019-03-27T14:59:57.000Z

Sample Request [JSON]

{
  "name": "1299",
  "companyName": "Curry Seed",
  "cropName": "SOYBEANS",
  "archived": true,
  "createdTime": "2019-03-28T14:59:57.000Z",
  "modifiedTime": "2019-03-27T14:59:57.000Z"
}

Sample Response

204 No Content
The update was completed successfully.

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.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: archived
value	object	Value for override parameter, can be string, number or boolean Example: true

Response Details

Field	Type	Description & Example
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: archived
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]

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    }
  ]
}

Sample Response

201 Created
Created successfully.

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  }
]

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.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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

Response Details

Field	Type	Description & Example
@type	string	--- Example: ReferenceVariety
id	string	Primary identifier for reference variety. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
referenceId^DEPRECATED	string	product id of the reference variety Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
category	string	--- Example: VARIETY Allowed Values: VARIETY
name	string	The common name of the reference variety. Example: S73-Z5 - 50lb bag
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
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
createdTime^DEPRECATED	string	product created time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modified time Example: 2019-03-27T14:59:57.000Z

Sample Response

200 OK

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/varieties?searchString=corn&itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/varieties?searchString=corn&itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "ReferenceVariety",
      "id": "1f8c12b4-126f-11ec-82a8-0242ac130003",
      "referenceId": "1f8c12b4-126f-11ec-82a8-0242ac130003",
      "category": "VARIETY",
      "name": "S73-Z5 - 50lb bag",
      "companyName": "NK",
      "cropName": "SOYBEANS",
      "countryCode": "USA",
      "sourceSystem": "3",
      "sourceSystemProductId": "905P24925",
      "createdTime": "2017-03-21T21:12:53.865Z",
      "modifiedTime": "2018-04-06T15:12:52.910Z"
    },
    {
      "@type": "ReferenceVariety",
      "id": "75138754-6381-49c7-be9e-9e08a847075a",
      "referenceId": "75138754-6381-49c7-be9e-9e08a847075a",
      "category": "VARIETY",
      "name": "Cornelius 155A",
      "companyName": "Cornelius Seed",
      "cropName": "ALFALFA",
      "countryCode": "USA",
      "sourceSystem": "3",
      "sourceSystemProductId": 105332,
      "createdTime": "2023-09-02T05:10:33.415Z",
      "modifiedTime": "2024-11-20T02:04:39.994Z"
    }
  ]
}

Get a single reference variety.

GET

/varieties/{erid}

Single variety from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path

Response Details

Field	Type	Description & Example
@type	string	--- Example: ReferenceVariety
id	string	Primary identifier for reference variety. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
referenceId^DEPRECATED	string	product id of the reference variety Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
category	string	--- Example: VARIETY Allowed Values: VARIETY
name	string	The common name of the reference variety. Example: S73-Z5 - 50lb bag
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
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
createdTime^DEPRECATED	string	product created time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modified time Example: 2019-03-27T14:59:57.000Z

Sample Response

200 OK

{
  "@type": "ReferenceVariety",
  "id": "1f8c12b4-126f-11ec-82a8-0242ac130003",
  "referenceId": "1f8c12b4-126f-11ec-82a8-0242ac130003",
  "category": "VARIETY",
  "name": "S73-Z5 - 50lb bag",
  "companyName": "NK",
  "cropName": "SOYBEANS",
  "countryCode": "USA",
  "sourceSystem": "3",
  "sourceSystemProductId": "905P24925",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z"
}

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.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path

Response Details

Field	Type	Description & Example
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
docType	string	Type of document for this product. Example: 24(c) Registration
productErid	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

Sample Response

200 OK

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/varieties/579f069a-3a0d-431d-a326-4fdbab12146c/documents?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/varieties/579f069a-3a0d-431d-a326-4fdbab12146c/documents?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "Document",
      "erid": "1f8c12b4-126f-11ec-82a8-0242ac130003",
      "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
      "docType": "24(c) Registration",
      "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
      "fileName": "ld7OD026.pdf",
      "expirationDate": "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.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid. Example: cf09acfc-9196-4dbb-9b38-1be02673c5ff	path
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: archived
value	object	Value for override parameter, can be string, number or boolean Example: true

Response Details

Field	Type	Description & Example
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: archived
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]

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    }
  ]
}

Sample Response

200 OK

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  }
]

Chemicals Endpoints

Retrieve unified list of custom and reference chemicals in your organization.

GET

/organizations/{organizationId}/chemicals

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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: activeIngredients,availableRegistrations,documents	query

Parameter

Type

Description & Example

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: activeIngredients,availableRegistrations,documents

query

Response Details

Field	Type	Description & Example
@type	string	--- Example: Chemical
id	string	The primary identifier for the chemical that is unique to your organization. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the route. Example: https://sandboxapi.deere.com/platform/{api_route}
name	string	The common name of the chemical. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName	string	The brand of the chemical. Example: Monsanto
materialClassification	string	--- Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
type	string	Specifies the type of the chemical. Manure and Fertilizer are deprecated, please use fertilizer endpoints. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the chemical from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
carrierId	string	The primary identifier in case it is a carrier. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceId^DEPRECATED	string	product reference id Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
liquidWeight	number	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the chemical. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
guid	string	The unique identifier for the active ingredient. Example: 9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4
percent^DEPRECATED	number	The percentage value of the active ingredient.' Example: 3.14
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
availableRegistrations	Array of string	List of available registrations for the countries this product is registered in. Only present when `embed=availableRegistrations` is used.
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label. Only present when `embed=documents` is used.
@type	---	--- Example: Document
productErid	string	The Unique id of the product where document attached. Example: 388ab719-277d-4032-a2c3-40a297d8f482
erid	string	The Unique id of the document. Example: 2e3d70e1-e1c2-40e8-97e8-8e6e095f9da7
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
epaRegistration^DEPRECATED	string	Registration id used for regulatory purposes. Example: a12e9i84
agencyRegistrations^DEPRECATED	Array of array	Registration detail used for regulatory purposes.
@type	string	The type of the registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the agency. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID for the agency. Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 20,
  "values": [
    {
      "@type": "Chemical",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/85f76746-fba2-48d0-bf7c-e46a79b00327"
        }
      ],
      "id": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "name": "AMS-All ",
      "type": "ADJUVANT",
      "category": "CHEMICAL",
      "companyName": "Drexel Chemical Company",
      "epaRegistration": "EXEMPT",
      "registration": "EXEMPT",
      "materialClassification": "LIQUID",
      "createdTime": "2024-10-18T10:00:08.480Z",
      "modifiedTime": "2024-10-18T10:00:08.729004Z",
      "referenceId": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "referenceGuid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "carrier": false,
      "archived": false,
      "restrictedUse": false,
      "agencyRegistrations": [
        {
          "@type": "AgencyRegistration",
          "links": [
            {
              "@type": "Link",
              "rel": "agency",
              "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
            }
          ],
          "registrationId": "EXEMPT"
        }
      ],
      "activeIngredients": [
        {
          "@type": "ActiveIngredient",
          "guid": "40ab45ee-96ef-4bfe-883a-fb65ced5b748",
          "name": "Ammonium sulfate",
          "percent": 40.25,
          "unit": "%",
          "value": 40.25
        }
      ],
      "availableRegistrations": [
        "EXEMPT"
      ],
      "documentsList": [
        {
          "@type": "Document",
          "erid": "4360eaf3-cd0e-486d-88d9-8153ca547084",
          "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
          "fileName": "ldC7J001.pdf",
          "docType": "Specimen Label",
          "description": "6422SP-0418"
        },
        {
          "@type": "Document",
          "erid": "8769a734-7a91-4b6d-b829-06e50e25ebc6",
          "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
          "fileName": "mpC7J002.pdf",
          "docType": "SDS",
          "description": "April 28, 2020"
        },
        {
          "@type": "Document",
          "erid": "d2c5f59f-1136-449e-9d62-017979f8a617",
          "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
          "fileName": "mpC7J004.pdf",
          "docType": "SDS",
          "description": "10/29/2024"
        }
      ]
    },
    {
      "@type": "Chemical",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/00e03fe1-421e-4b2d-870e-9c1f010fba66"
        }
      ],
      "id": "00e03fe1-421e-4b2d-870e-9c1f010fba66",
      "name": "Chemical-Fungicide (Liquid)",
      "type": "FUNGICIDE",
      "category": "CHEMICAL",
      "companyName": "Koch Agronomic Services, LLC",
      "carrier": false,
      "archived": true,
      "restrictedUse": false,
      "activeIngredients": [],
      "availableRegistrations": [],
      "documentsList": []
    }
  ]
}

Add chemical

POST

/organizations/{organizationId}/chemicals

This endpoint will add a custom chemical into the organization. Its name+type must be unique within your organization, unless carrier is set to true. If carrier is set to true, then type is disregarded. A chemical's carrier property cannot be changed to false once set to true. A chemical cannot be archived if it is in an active tank mix or dry blend. If a chemical is marked as archived and is used in a tank mix/dry blend, if the tank mix/dry blend is made available, then this chemical will also be made available. If passing in a liquid weight or weight unit, material classification should be set to LIQUID.

Additionally, POST can be used for supporting offline creation of chemicals 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: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
@type	---	--- Example: Chemical
name Required	string	The common name of the chemical. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName Required	string	The brand of the chemical. Example: Monsanto
materialClassification	string	Specifies the state of the chemical. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
type Required	string	The type of the chemical. Manure and Fertilizer are deprecated, please use fertilizer endpoints. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the chemical from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
epaRegistration^DEPRECATED	string	Registration id used for regulatory purposes. Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modification time Example: 2019-03-27T14:59:57.000Z
agencyRegistrations^DEPRECATED	Array of array	Registration detail used for regulatory purposes.
@type	string	The type of the registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the agency. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID for the agency. Example: a12e9i84

Sample Request [JSON]

{
  "@type": "Chemical",
  "name": "Tide Propiconazole 41.8EC",
  "registration": "a12e9i84",
  "companyName": "Tide International USA, Inc.",
  "type": "HERBICIDE",
  "restrictedUse": false,
  "materialClassification": "DRY",
  "carrier": false,
  "archived": false,
  "referenceGuid": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
  "epaRegistration": "a12e9i84",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z",
  "agencyRegistrations": [
    {
      "@type": "AgencyRegistration",
      "links": [
        {
          "@type": "Link",
          "rel": "agency",
          "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
        }
      ],
      "registrationId": "a12e9i84"
    }
  ]
}

Sample Response

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

Retrieve a specific chemical from an organization's asset list.

GET

/organizations/{organizationId}/chemicals/{erid}

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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: activeIngredients,availableRegistrations,documents	query

Response Details

Field	Type	Description & Example
@type	string	--- Example: Chemical
id	string	The primary identifier for the chemical that is unique to your organization. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the route. Example: https://sandboxapi.deere.com/platform/{api_route}
name	string	The common name of the chemical. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName	string	The brand of the chemical. Example: Monsanto
materialClassification	string	--- Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
type	string	Specifies the type of the chemical. Manure and Fertilizer are deprecated, please use fertilizer endpoints. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the chemical from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
carrierId	string	The primary identifier in case it is a carrier. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceId^DEPRECATED	string	product reference id Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
liquidWeight	number	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the chemical. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
guid	string	The unique identifier for the active ingredient. Example: 9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4
percent^DEPRECATED	number	The percentage value of the active ingredient.' Example: 3.14
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
availableRegistrations	Array of string	List of available registrations for the countries this product is registered in. Only present when `embed=availableRegistrations` is used.
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label. Only present when `embed=documents` is used.
@type	---	--- Example: Document
productErid	string	The Unique id of the product where document attached. Example: 388ab719-277d-4032-a2c3-40a297d8f482
erid	string	The Unique id of the document. Example: 2e3d70e1-e1c2-40e8-97e8-8e6e095f9da7
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
epaRegistration^DEPRECATED	string	Registration id used for regulatory purposes. Example: a12e9i84
agencyRegistrations^DEPRECATED	Array of array	Registration detail used for regulatory purposes.
@type	string	The type of the registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the agency. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID for the agency. Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
  "@type": "Chemical",
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/85f76746-fba2-48d0-bf7c-e46a79b00327"
    }
  ],
  "id": "85f76746-fba2-48d0-bf7c-e46a79b00327",
  "name": "AMS-All ",
  "type": "ADJUVANT",
  "category": "CHEMICAL",
  "companyName": "Drexel Chemical Company",
  "epaRegistration": "EXEMPT",
  "registration": "EXEMPT",
  "materialClassification": "LIQUID",
  "createdTime": "2024-10-18T10:00:08.480Z",
  "modifiedTime": "2024-10-18T10:00:08.729004Z",
  "referenceId": "85f76746-fba2-48d0-bf7c-e46a79b00327",
  "referenceGuid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
  "carrier": false,
  "archived": false,
  "restrictedUse": false,
  "agencyRegistrations": [
    {
      "@type": "AgencyRegistration",
      "links": [
        {
          "@type": "Link",
          "rel": "agency",
          "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
        }
      ],
      "registrationId": "EXEMPT"
    }
  ],
  "activeIngredients": [
    {
      "@type": "ActiveIngredient",
      "guid": "40ab45ee-96ef-4bfe-883a-fb65ced5b748",
      "name": "Ammonium sulfate",
      "percent": 40.25,
      "unit": "%",
      "value": 40.25
    }
  ],
  "availableRegistrations": [
    "EXEMPT"
  ],
  "documentsList": [
    {
      "@type": "Document",
      "erid": "4360eaf3-cd0e-486d-88d9-8153ca547084",
      "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "fileName": "ldC7J001.pdf",
      "docType": "Specimen Label",
      "description": "6422SP-0418"
    },
    {
      "@type": "Document",
      "erid": "8769a734-7a91-4b6d-b829-06e50e25ebc6",
      "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "fileName": "mpC7J002.pdf",
      "docType": "SDS",
      "description": "April 28, 2020"
    },
    {
      "@type": "Document",
      "erid": "d2c5f59f-1136-449e-9d62-017979f8a617",
      "productErid": "85f76746-fba2-48d0-bf7c-e46a79b00327",
      "fileName": "mpC7J004.pdf",
      "docType": "SDS",
      "description": "10/29/2024"
    }
  ]
}

Update a single chemical

PUT

/organizations/{organizationId}/chemicals/{erid}

Allows the custom chemical to be renamed, made active/archived, or flagged as a carrier.

OAuth Scope Required: eq2

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{organizationId}/chemicals/{erid}

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
@type	---	--- Example: Chemical
name Required	string	The common name of the chemical. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName Required	string	The brand of the chemical. Example: Monsanto
materialClassification	string	--- Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
type Required	string	The type for the chemical. Manure and Fertilizer are deprecated, please use fertilizer endpoints. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the chemical from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
liquidWeight	number	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: 3.14
epaRegistration^DEPRECATED	string	Registration id used for regulatory purposes. Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2017-03-21T21:12:53.865Z
modifiedTime^DEPRECATED	string	product modification time Example: 2018-04-06T15:12:52.910Z
weightUnit	string	Optional. Will be present if the chemical's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the chemical. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
guid	string	The unique identifier for the active ingredient. Example: 9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4
percent^DEPRECATED	number	The percentage value of the active ingredient.' Example: 3.14
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14

Sample Request [JSON]

{
  "@type": "Chemical",
  "name": "Tide Propiconazole 41.8EC",
  "registration": "a12e9i84",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "GAS",
  "carrier": false,
  "archived": false,
  "restrictedUse": false,
  "referenceGuid": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
  "liquidWeight": 3.14,
  "weightUnit": "lb/gal",
  "epaRegistration": "a12e9i84",
  "createdTime": "2017-03-20T21:12:53.870Z",
  "modifiedTime": "2017-03-22T21:12:53.870Z",
  "agencyRegistrations": [
    {
      "@type": "AgencyRegistration",
      "links": [
        {
          "@type": "Link",
          "rel": "agency",
          "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
        }
      ],
      "registrationId": "a12e9i84"
    }
  ]
}

Sample Response

204 No Content

Adds a single reference chemical to organization

POST

/chemicals/{erid}/associateToOrg/{organizationId}

This endpoint will associate a reference chemical to your organization from the global reference list. The reference chemicals are immutable, however, they can still be archived or made available. If a reference chemical is created as a carrier, it cannot be changed thereafter. The registration of a reference chemical can also be updated. The response headers from the GET endpoints will include the attributes that can be overridden.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: isCarrier,archived,registration
value	string	Value for the override parameter Example: true

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    },
    {
      "key": "registration",
      "value": "EXEMPT"
    },
    {
      "key": "isCarrier",
      "value": true
    }
  ]
}

Sample Response

201 Created

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  },
  {
    "key": "isCarrier",
    "success": true,
    "errors": []
  },
  {
    "key": "registration",
    "success": true,
    "errors": []
  }
]

Reference list of all known chemicals

GET

/chemicals

List of all chemicals from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
searchString	string	performs a fuzzy search on product name, manufacturer, and chemical type. Example: Roundup	query
chemicalType	string	Specifies the registration number of the chemical based on the country or region/state of use. Example: INSECTICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER	query
productName	string	Specifies the name of the chemical in the global reference list. Example: RoundUp	query
brandName	string	Specifies the product manufacturer name of the chemical based on the region being used. Example: MONSANTO AGRICULTURAL CO	query
registration	string	Specifies the registration number of the chemical based on the region of use. Example: 89167-72-89391	query
sourceSystemProductId	string	Specifies the source system product id of the chemical based on the country of use. Example: 905P24930	query
countryCode	string	Specifies the region the chemical data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA	query

Response Details

Field	Type	Description & Example
@type	string	--- Example: ReferenceChemical
id	string	The primary identifier of the reference chemical. Example: 8fb34898-64f5-5a1e-a698-34ab348220a7
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the route. Example: https://sandboxapi.deere.com/platform/{api_route}
name	string	The common name of the reference chemical. Example: Round Up
companyName	string	The name of the input manufacturer. Example: Monsanto
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
referenceId^DEPRECATED	string	product reference id Example: 8fb34898-64f5-5a1e-a698-34ab348220a7
materialClassification	string	The state of reference chemical. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
countryCode	string	Specifies the region the reference chemical data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA
type	string	Specifies the type of chemical. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
sourceSystem	string	The source system for the reference chemical. Example: 3
sourceSystemProductId	string	The source system identifier for the reference chemical. Example: 905P24925
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
epaRegistration^DEPRECATED	string	product registration id Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/chemicals?searchString=round&itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/chemicals?searchString=round&itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "ReferenceChemical",
      "id": "8fb34898-64f5-5a1e-a698-34ab348220a7",
      "name": "Round Up",
      "companyName": "Monsanto",
      "registration": "a12e9i84",
      "materialClassification": "LIQUID",
      "category": "CHEMICAL",
      "epaRegistration": "a12e9i84",
      "referenceId": "8fb34898-64f5-5a1e-a698-34ab348220a7",
      "createdTime": "2017-03-21T21:12:53.865Z",
      "modifiedTime": "2018-04-06T15:12:52.910Z",
      "countryCode": "USA",
      "type": "HERBICIDE",
      "restrictedUse": false,
      "sourceSystem": "3",
      "sourceSystemProductId": "905P24925"
    },
    {
      "@type": "ReferenceChemical",
      "id": "bef74fe4-95bf-4e00-9833-b5b8272177c8",
      "name": "SOURCE® Corn",
      "category": "CHEMICAL",
      "type": "HERBICIDE",
      "companyName": "Sound Agriculture",
      "epaRegistration": "EXEMPT",
      "registration": "EXEMPT",
      "materialClassification": "LIQUID",
      "createdTime": "2023-09-02T01:32:21.945933Z",
      "modifiedTime": "2023-11-15T16:40:15.451Z",
      "sourceSystem": "3",
      "sourceSystemProductId": "20265",
      "countryCode": "USA",
      "referenceId": "bef74fe4-95bf-4e00-9833-b5b8272177c8",
      "referenceGuid": "bef74fe4-95bf-4e00-9833-b5b8272177c8",
      "restrictedUse": false
    },
    {
      "@type": "ReferenceChemical",
      "id": "aa1ffc6e-edcd-4112-b62d-74cdad35fa03",
      "name": "Roundup Ultra®",
      "category": "CHEMICAL",
      "type": "HERBICIDE",
      "companyName": "BAYER CROPSCIENCE",
      "epaRegistration": "524-475",
      "registration": "524-475",
      "materialClassification": "LIQUID",
      "createdTime": "2023-09-02T01:22:00.669119Z",
      "modifiedTime": "2024-11-19T15:20:10.752Z",
      "sourceSystem": "3",
      "sourceSystemProductId": "856",
      "countryCode": "USA",
      "referenceId": "aa1ffc6e-edcd-4112-b62d-74cdad35fa03",
      "referenceGuid": "aa1ffc6e-edcd-4112-b62d-74cdad35fa03",
      "restrictedUse": false
    }
  ]
}

Get a single reference chemical

GET

/chemicals/{erid}

Single chemical from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid.	path

Response Details

Field	Type	Description & Example
@type	string	--- Example: ReferenceChemical
id	string	The primary identifier of the reference chemical. Example: 8fb34898-64f5-5a1e-a698-34ab348220a7
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the route. Example: https://sandboxapi.deere.com/platform/{api_route}
name	string	The common name of the reference chemical. Example: Round Up
companyName	string	The name of the input manufacturer. Example: Monsanto
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
referenceId^DEPRECATED	string	product reference id Example: 8fb34898-64f5-5a1e-a698-34ab348220a7
materialClassification	string	The state of reference chemical. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: CHEMICAL Allowed Values: CHEMICAL
countryCode	string	Specifies the region the reference chemical data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA
type	string	Specifies the type of chemical. Example: HERBICIDE Allowed Values: ADDITIVE,ADJUVANT,DEFOLIANT,FUNGICIDE,GROWTH_REGULATOR,HERBICIDE,INSECTICIDE,NITROGEN_STABILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
sourceSystem	string	The source system for the reference chemical. Example: 3
sourceSystemProductId	string	The source system identifier for the reference chemical. Example: 905P24925
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
epaRegistration^DEPRECATED	string	product registration id Example: a12e9i84
createdTime^DEPRECATED	string	product creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	product modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

{
  "@type": "ReferenceChemical",
  "id": "8fb34898-64f5-5a1e-a698-34ab348220a7",
  "name": "Round Up",
  "companyName": "Monsanto",
  "registration": "a12e9i84",
  "materialClassification": "LIQUID",
  "category": "CHEMICAL",
  "countryCode": "USA",
  "type": "HERBICIDE",
  "restrictedUse": false,
  "sourceSystem": "3",
  "epaRegistration": "a12e9i84",
  "sourceSystemProductId": "905P24925",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z"
}

Reference list of documents for an associated chemical

GET

/chemicals/{erid}/documents

List of all the documents for a chemical from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid.	path

Response Details

Field	Type	Description & Example
@type	---	--- Example: Document
productErid	string	The Unique id of the product where document attached. Example: 388ab719-277d-4032-a2c3-40a297d8f482
erid	string	The Unique id of the document. Example: 2e3d70e1-e1c2-40e8-97e8-8e6e095f9da7
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

Sample Response [JSON]

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/chemicals/2efdaf0a-254c-4ba2-9a1f-b3c94f962224/documents?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "next",
      "uri": "https://sandboxapi.deere.com/platform/chemicals/2efdaf0a-254c-4ba2-9a1f-b3c94f962224/documents?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "Document",
      "erid": "1f8c12b4-126f-11ec-82a8-0242ac130003",
      "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
      "docType": "24(c) Registration",
      "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
      "fileName": "ld7OD026.pdf",
      "expirationDate": "2017-03-22"
    },
    {
      "@type": "Document",
      "erid": "6d0b01a5-05b7-4c2b-985b-c322939f92cb",
      "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
      "fileName": "mp6EE011.pdf",
      "docType": "SDS",
      "description": "2/26/2021"
    }
  ]
}

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

PATCH

/chemicals/{erid}/setOverridesForOrg/{organizationId}

This endpoint will set attribute overrides while importing a reference chemical to your organization. The reference chemicals are immutable, however, they can still be archived or made available. Once set to true, the carrier attribute cannot be set to false. The registration of a reference chemical can be updated. The response headers from the GET endpoints will include the attributes that can be overridden.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: isCarrier,archived,registration
value	string	Value for the override parameter Example: true

Response Details

Field	Type	Description & 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]

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    },
    {
      "key": "registration",
      "value": "EXEMPT"
    },
    {
      "key": "isCarrier",
      "value": true
    }
  ]
}

Sample Response

200 Created

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  },
  {
    "key": "isCarrier",
    "success": true,
    "errors": []
  },
  {
    "key": "registration",
    "success": true,
    "errors": []
  }
]

Additional Information

Material Classification: LIQUID, DRY, GAS.
Type: ADDITIVE, FUNGICIDE, INSECTICIDE, HERBICIDE, GROWTH_REGULATOR, NITROGEN_STABILIZER, ADJUVANT, DEFOLIANT.

Fertilizers Endpoints

Retrieve unified list of custom and reference fertilizers in your organization.

GET

/organizations/{organizationId}/fertilizers

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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: activeIngredients,availableRegistrations,documents	query

Parameter

Type

Description & Example

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: activeIngredients,availableRegistrations,documents

query

Response Details

Field	Type	Description & Example
@type	string	--- Example: Fertilizer
id	string	The primary identifier for the fertilizer that is unique to your organization. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
name	string	The common name of the fertilizer. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName	string	The brand of the fertilizer. Example: Monsanto
materialClassification	string	Specifies the state of the fertilizer. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
type	string	The type of the fertilizer. Example: MANURE Allowed Values: MANURE,FERTILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the fertilizer from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
referenceId^DEPRECATED	string	product reference id Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
carrierId	string	The primary identifier in case it is a carrier. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
liquidWeight	number	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the fertilizer. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
id	string	The primary identifier of the active ingredient. Example: 30ca101c-e78f-4e45-a248-1ce9622c7f10
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
availableRegistrations	Array of string	List of available registrations for the countries this product is registered in. Only present when `embed=availableRegistrations` is used.
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label. Only present when `embed=documents` is used.
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
productErid	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
agencyRegistrations^DEPRECATED	Array of array	production registration number details
@type	string	The type of the registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the agency. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID for the agency. Example: a12e9i84
epaRegistration^DEPRECATED	string	production registration number Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/356823/fertilizers?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/organizations/356823/fertilizers?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 20,
  "values": [
    {
      "@type": "Fertilizer",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/356823/fertilizers/e2f8093a-b1ec-4bd4-a8de-aa83855cbd15"
        }
      ],
      "id": "e2f8093a-b1ec-4bd4-a8de-aa83855cbd15",
      "type": "FERTILIZER",
      "category": "MANURE",
      "companyName": "Tide International USA,Inc.",
      "name": "Tide Propiconazole 41.8EC",
      "registration": "a12e9i84",
      "epaRegistration": "a12e9i84",
      "materialClassification": "DRY",
      "restrictedUse": false,
      "createdTime": "2018-04-30T08:30:19.326Z",
      "modifiedTime": "2018-04-26T15:13:32.890Z",
      "carrier": false,
      "archived": false,
      "carrierId": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
      "referenceGuid": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
      "referenceId": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
      "agencyRegistrations": [
        {
          "@type": "AgencyRegistration",
          "links": [
            {
              "@type": "Link",
              "rel": "agency",
              "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
            }
          ],
          "registrationId": "EXEMPT"
        }
      ],
      "liquidWeight": 3.14,
      "weightUnit": "lb/gal",
      "activeIngredients": [
        {
          "name": "Urea Nitrogen",
          "guid": "9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4",
          "percent": 3.14,
          "unit": "%",
          "value": 3.14
        }
      ],
      "availableRegistrations": [
        "a12e9i84, 0000264-00783-AA-0067760"
      ],
      "documentsList": [
        {
          "@type": "Document",
          "erid": "08e930ee-4c31-41b6-b57e-8c0a8e1284a4",
          "docType": "24(c) Registration",
          "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
          "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
          "fileName": "ld7OD026.pdf",
          "expirationDate": "2017-03-22"
        }
      ]
    },
    {
      "@type": "Fertilizer",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/356823/fertilizers/6c42adb6-15ce-4f63-9528-c91470900e2c"
        }
      ],
      "id": "6c42adb6-15ce-4f63-9528-c91470900e2c",
      "name": "SOURCE Corn",
      "type": "FERTILIZER",
      "category": "FERTILIZER",
      "companyName": "Sound Agriculture",
      "epaRegistration": "EXEMPT",
      "registration": "EXEMPT",
      "materialClassification": "LIQUID",
      "createdTime": "2024-12-05T06:43:57.118Z",
      "referenceId": "6c42adb6-15ce-4f63-9528-c91470900e2c",
      "referenceGuid": "6c42adb6-15ce-4f63-9528-c91470900e2c",
      "carrier": false,
      "archived": false,
      "restrictedUse": false,
      "liquidWeight": 8.45,
      "weightUnit": "lbs/gal",
      "agencyRegistrations": [
        {
          "@type": "AgencyRegistration",
          "links": [
            {
              "@type": "Link",
              "rel": "agency",
              "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
            }
          ],
          "registrationId": "EXEMPT"
        }
      ],
      "activeIngredients": [
        {
          "name": "Urea Nitrogen",
          "guid": "9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4",
          "percent": 3.14,
          "unit": "%",
          "value": 3.14
        }
      ],
      "availableRegistrations": [
        "a12e9i84, 0000264-00783-AA-0067760"
      ],
      "documentsList": [
        {
          "@type": "Document",
          "erid": "08e930ee-4c31-41b6-b57e-8c0a8e1284a4",
          "docType": "24(c) Registration",
          "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
          "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
          "fileName": "ld7OD026.pdf",
          "expirationDate": "2017-03-22"
        }
      ]
    }
  ]
}

Add fertilizer

POST

/organizations/{organizationId}/fertilizers

This endpoint will add a custom fertilizer into the organization. Its name+type must be unique within your organization, unless carrier is set to true. If carrier is set to true, then type is disregarded. A fertilizer's carrier property cannot be changed to false once set to true. A fertilizer cannot be archived if it is in an active tank mix or dry blend. If a fertilizer is marked as archived and is used in a tank mix/dry blend, if the tank mix/dry blend is made available, then this fertilizer will also be made available. If passing in a liquid weight or weight unit, material classification should be set to LIQUID.

Additionally, POST can be used for supporting offline creation of fertilizers 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: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
@type	---	--- Example: Fertilizer
name Required	string	The common name of the fertilizer. Example: Manure
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName Required	string	The brand of the fertilizer. Example: Monsanto
materialClassification	string	Specifies the state of the fertilizer. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
type Required	string	The type for the fertilizer. Example: null Allowed Values: MANURE,FERTILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the fertilizer from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
liquidWeight	number	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the fertilizer. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
id	string	The primary identifier of the active ingredient. Example: 30ca101c-e78f-4e45-a248-1ce9622c7f10
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
epaRegistration^DEPRECATED	string	production registration number Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z

Sample Request [JSON]

{
  "@type": "Fertilizer",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "DRY",
  "registration": "a12e9i84",
  "restrictedUse": false,
  "category": "FERTILIZER",
  "carrier": false,
  "archived": false,
  "liquidWeight": 3.14,
  "weightUnit": "lb/gal",
  "activeIngredients": [
    {
      "name": "Urea Nitrogen",
      "guid": "9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4",
      "percent": 3.14,
      "unit": "%",
      "value": 3.14
    }
  ],
  "epaRegistration": "a12e9i84",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z"
}

Sample Response

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

Retrieve a specific fertilizer from an organization's asset list.

GET

/organizations/{organizationId}/fertilizers/{erid}

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
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: activeIngredients,availableRegistrations,documents	query

Response Details

Field	Type	Description & Example
@type	string	--- Example: Fertilizer
id	string	The primary identifier for the fertilizer that is unique to your organization. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
name	string	The common name of the fertilizer. Example: Round Up
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName	string	The brand of the fertilizer. Example: Monsanto
materialClassification	string	Specifies the state of the fertilizer. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
type	string	The type of the fertilizer. Example: MANURE Allowed Values: MANURE,FERTILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the fertilizer from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
referenceId^DEPRECATED	string	product reference id Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
carrierId	string	The primary identifier in case it is a carrier. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
liquidWeight	number	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the fertilizer. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
id	string	The primary identifier of the active ingredient. Example: 30ca101c-e78f-4e45-a248-1ce9622c7f10
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
availableRegistrations	Array of string	List of available registrations for the countries this product is registered in. Only present when `embed=availableRegistrations` is used.
documentsList	Array of object	List of documents for the variety. For example, Tech Sheet, SDS Label. Only present when `embed=documents` is used.
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
productErid	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
agencyRegistrations^DEPRECATED	Array of array	production registration number details
@type	string	The type of the registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the agency. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID for the agency. Example: a12e9i84
epaRegistration^DEPRECATED	string	production registration number Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

[
  {
    "@type": "Fertilizer",
    "links": [
      {
        "@type": "Link",
        "rel": "self",
        "uri": "https://sandboxapi.deere.com/platform/organizations/356823/fertilizers/e2f8093a-b1ec-4bd4-a8de-aa83855cbd15"
      }
    ],
    "id": "e2f8093a-b1ec-4bd4-a8de-aa83855cbd15",
    "type": "FERTILIZER",
    "category": "MANURE",
    "companyName": "Tide International USA,Inc.",
    "name": "Tide Propiconazole 41.8EC",
    "registration": "a12e9i84",
    "epaRegistration": "a12e9i84",
    "materialClassification": "DRY",
    "restrictedUse": false,
    "createdTime": "2018-04-30T08:30:19.326Z",
    "modifiedTime": "2018-04-26T15:13:32.890Z",
    "carrier": false,
    "archived": false,
    "carrierId": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
    "referenceGuid": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
    "referenceId": "87b4a1e7-210b-482c-8a7a-19e9f644e914",
    "agencyRegistrations": [
      {
        "@type": "AgencyRegistration",
        "links": [
          {
            "@type": "Link",
            "rel": "agency",
            "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
          }
        ],
        "registrationId": "EXEMPT"
      }
    ],
    "liquidWeight": 3.14,
    "weightUnit": "lb/gal",
    "activeIngredients": [
      {
        "name": "Urea Nitrogen",
        "guid": "9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4",
        "percent": 3.14,
        "unit": "%",
        "value": 3.14
      }
    ],
    "availableRegistrations": [
      "a12e9i84, 0000264-00783-AA-0067760"
    ],
    "documentsList": [
      {
        "@type": "Document",
        "erid": "08e930ee-4c31-41b6-b57e-8c0a8e1284a4",
        "docType": "24(c) Registration",
        "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
        "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
        "fileName": "ld7OD026.pdf",
        "expirationDate": "2017-03-22"
      }
    ]
  }
]

Update a single fertilizer

PUT

/organizations/{organizationId}/fertilizers/{erid}

Allows the fertilizer custom to be renamed, made active/archived, or flagged as a carrier.

OAuth Scope Required: eq2

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{organizationId}/fertilizers/{erid}

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
@type	---	--- Example: Fertilizer
name	string	The common name of the fertilizer. Example: Manure
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
companyName	string	The brand of the fertilizer. Example: Monsanto
materialClassification	string	Specifies the state of the fertilizer. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
type	string	The type for the fertilizer. Example: null Allowed Values: MANURE,FERTILIZER
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
archived	boolean	Whether or not this product is actively used in your organization. A value of true will hide the fertilizer from display in your organization. A carrier cannot be archived if it is being used in an active tank mix. Example: false
carrier	boolean	Whether or not this product has been flagged for use as a tank mix carrier. Only applicable in an organizational context. If set to true, cannot subsequently set to false. Also, carrier names must be unique within the organization regardless of their type. Example: false
liquidWeight	number	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: 3.14
weightUnit	string	Optional. Will be present if the fertilizer's materialClassification is LIQUID and has density information available. Example: lb/gal
activeIngredients	Array of object	List of active ingredients present in the fertilizer. Includes the name and quantity of each ingredient. Only present when `embed=activeIngredients` is used.
@type	string	--- Example: ActiveIngredient
id	string	The primary identifier of the active ingredient. Example: 30ca101c-e78f-4e45-a248-1ce9622c7f10
name	string	The name of the active ingredient. Example: Urea Nitrogen
unit	string	The unit of measurement used for the value of active ingredient. Example: %
value	number	The value of the active ingredient in the Chemical/Fertilizer. Example: 3.14
epaRegistration^DEPRECATED	string	production registration number Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z

Sample Request [JSON]

{
  "@type": "Fertilizer",
  "name": "Tide Propiconazole 41.8EC",
  "companyName": "Tide International USA, Inc.",
  "type": "MANURE",
  "materialClassification": "DRY",
  "registration": "a12e9i84",
  "restrictedUse": false,
  "category": "FERTILIZER",
  "carrier": false,
  "archived": false,
  "liquidWeight": 3.14,
  "weightUnit": "lb/gal",
  "activeIngredients": [
    {
      "name": "Urea Nitrogen",
      "guid": "9ab0fd0d-7ed0-49bd-9a61-0277d89b61f4",
      "percent": 3.14,
      "unit": "%",
      "value": 3.14
    }
  ],
  "epaRegistration": "a12e9i84",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z"
}

Sample Response

204 No Content

Adds a single reference fertilizer to organization

POST

/fertilizers/{erid}/associateToOrg/{organizationId}

This endpoint will associate a reference fertilizer to your organization from the global reference list. The reference fertilizers are immutable, however, they can still be archived or made available. If a reference fertilizer is created as a carrier, it cannot be changed thereafter. The registration of a reference fertilizer can also be updated. The response headers from the GET endpoints will include the attributes that can be overridden.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: isCarrier,archived,registration
value	string	Value for the override parameter Example: true

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    },
    {
      "key": "registration",
      "value": "EXEMPT"
    },
    {
      "key": "isCarrier",
      "value": true
    }
  ]
}

Sample Response

200 Created

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  },
  {
    "key": "isCarrier",
    "success": true,
    "errors": []
  },
  {
    "key": "registration",
    "success": true,
    "errors": []
  }
]

Reference list of all known fertilizers

GET

/fertilizers

List of all fertilizers from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
searchString	string	performs a fuzzy search on product name, manufacturer, and fertilizer type Example: Manure	query
fertilizerType	string	Specifies the registration number of the fertilizer based on the country or region/state of use. Example: FERTILIZER Allowed Values: FERTILIZER,MANURE	query
productName	string	Specifies the name of the fertilizer in the global reference list. Example: ProNatural® Calcium Plus 1-0-0	query
brandName	string	Specifies the product manufacturer name of the fertilizer based on the region being used. Example: Wilbur-Ellis Company LLC	query
registration	string	Specifies the registration number of the fertilizer based on the region of use. Example: EXEMPT	query
sourceSystemProductId	string	Specifies the source system product id of the fertilizer based on the country of use. Example: 13328	query
countryCode	string	Specifies the region the fertilizer data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA	query

Response Details

Field	Type	Description & Example
@type	string	--- Example: Fertilizer
id	string	The primary identifier for the fertilizer. Example: beaa8d07-1cef-4eea-99b6-19f129e988ed
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
name	string	The common name of the reference fertilizer. Example: Round Up
companyName	string	The name of the input manufacturer. Example: Monsanto
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
materialClassification	string	Specifies the state of the chemical. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
countryCode	string	Specifies the region the reference fertilizer data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA
type	string	Specifies the type of the reference fertilizer. Example: MANURE Allowed Values: MANURE,FERTILIZER
referenceId^DEPRECATED	string	product reference id Example: beaa8d07-1cef-4eea-99b6-19f129e988ed
epaRegistration^DEPRECATED	string	production registration number details Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
sourceSystem	string	The source system for the reference fertilizer. Example: 3
sourceSystemProductId	string	The source system identifier for the reference fertilizer. Example: 905P24925

Sample Response

200 OK

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/fertilizers?searchString=corn&itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/fertilizers?searchString=corn&itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "Fertilizer",
      "id": "beaa8d07-1cef-4eea-99b6-19f129e988ed",
      "referenceId": "beaa8d07-1cef-4eea-99b6-19f129e988ed",
      "name": "Round Up",
      "companyName": "Monsanto",
      "registration": "a12e9i84",
      "materialClassification": "LIQUID",
      "category": "FERTILIZER",
      "countryCode": "USA",
      "epaRegistration": "a12e9i84",
      "createdTime": "2017-03-21T21:12:53.865Z",
      "modifiedTime": "2018-04-06T15:12:52.910Z",
      "type": "MANURE",
      "restrictedUse": false,
      "sourceSystem": "3",
      "sourceSystemProductId": "905P24925"
    },
    {
      "@type": "Fertilizer",
      "id": "4dad43d3-4392-41c3-abcb-3eeed86bb3fb",
      "referenceId": "4dad43d3-4392-41c3-abcb-3eeed86bb3fb",
      "name": "Corn Mix LS",
      "companyName": "WinField United",
      "registration": "EXEMPT",
      "materialClassification": "LIQUID",
      "category": "FERTILIZER",
      "countryCode": "USA",
      "epaRegistration": "EXEMPT",
      "createdTime": "2023-11-02T22:49:10.585718Z",
      "modifiedTime": "2024-11-19T17:51:38.225Z",
      "type": "FERTILIZER",
      "restrictedUse": false,
      "sourceSystem": "3",
      "sourceSystemProductId": 13977
    }
  ]
}

Single reference fertilizer

GET

/fertilizers/{erid}

Single fertilizer from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid.	path

Response Details

Field	Type	Description & Example
@type	string	--- Example: Fertilizer
id	string	The primary identifier for the fertilizer. Example: beaa8d07-1cef-4eea-99b6-19f129e988ed
links	Array of object	Provides a reference to an associated object or list.
@type	string	The type of the link. Example: Link
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: api_route
name	string	The common name of the reference fertilizer. Example: Round Up
companyName	string	The name of the input manufacturer. Example: Monsanto
registration	string	Registration id used for regulatory purposes. Example: a12e9i84
materialClassification	string	Specifies the state of the chemical. Example: LIQUID Allowed Values: DRY,LIQUID,GAS
category	string	--- Example: FERTILIZER Allowed Values: FERTILIZER
referenceGuid	string	Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914
countryCode	string	Specifies the region the reference fertilizer data belongs to. Some data may not be available in certain regions and data will not be included in the response. Example: USA
type	string	Specifies the type of the reference fertilizer. Example: MANURE Allowed Values: MANURE,FERTILIZER
referenceId^DEPRECATED	string	product reference id Example: beaa8d07-1cef-4eea-99b6-19f129e988ed
epaRegistration^DEPRECATED	string	production registration number details Example: a12e9i84
createdTime^DEPRECATED	string	production creation time Example: 2019-03-27T14:59:57.000Z
modifiedTime^DEPRECATED	string	production modification time Example: 2019-03-27T14:59:57.000Z
restrictedUse	boolean	Whether or not the product is restricted for use by the governing entity. Example: false
sourceSystem	string	The source system for the reference fertilizer. Example: 3
sourceSystemProductId	string	The source system identifier for the reference fertilizer. Example: 905P24925

Sample Response

200 OK

{
  "@type": "Fertilizer",
  "id": "beaa8d07-1cef-4eea-99b6-19f129e988ed",
  "referenceId": "beaa8d07-1cef-4eea-99b6-19f129e988ed",
  "name": "Round Up",
  "companyName": "Monsanto",
  "registration": "a12e9i84",
  "epaRegistration": "a12e9i84",
  "materialClassification": "LIQUID",
  "category": "FERTILIZER",
  "countryCode": "USA",
  "createdTime": "2017-03-21T21:12:53.865Z",
  "modifiedTime": "2018-04-06T15:12:52.910Z",
  "type": "MANURE",
  "restrictedUse": false,
  "sourceSystem": "3",
  "sourceSystemProductId": "905P24925"
}

Reference list of documents for an associated fertilizer

GET

/fertilizers/{erid}/documents

List of all the documents for a fertilizer from industry data sources, such as CDMS.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid.	path

Response Details

Field	Type	Description & Example
@type	---	--- Example: Document
erid	string	Unique id of the document Example: 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
productErid	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

Sample Response

200 OK

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/varieties/579f069a-3a0d-431d-a326-4fdbab12146c/documents?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/varieties/579f069a-3a0d-431d-a326-4fdbab12146c/documents?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 100,
  "values": [
    {
      "@type": "Document",
      "erid": "1f8c12b4-126f-11ec-82a8-0242ac130003",
      "productErid": "388ab719-277d-4032-a2c3-40a297d8f482",
      "docType": "24(c) Registration",
      "description": "CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed",
      "fileName": "ld7OD026.pdf",
      "expirationDate": "2017-03-22"
    },
    {
      "@type": "Document",
      "erid": "5c2dd6b0-3f66-437c-910b-634c9e83e205",
      "productErid": "4dad43d3-4392-41c3-abcb-3eeed86bb3fb",
      "fileName": "mpCO7001.pdf",
      "docType": "SDS",
      "description": "April 6, 2020"
    }
  ]
}

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

PATCH

/fertilizers/{erid}/setOverridesForOrg/{organizationId}

This endpoint will set attribute overrides while importing a reference fertilizer to your organization. The reference fertilizers are immutable, however, they can still be archived or made available. Once set to true, the carrier attribute cannot be set to false. The registration of a reference fertilizer can be updated. The response headers from the GET endpoints will include the attributes that can be overridden.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
overrides	Array of object	---
key	string	Key for override parameter when setting overrides for a reference product Example: archived Allowed Values: isCarrier,archived,registration
value	string	Value for the override parameter Example: true

Response Details

Field	Type	Description & 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]

Sample Request [JSON]

{
  "overrides": [
    {
      "key": "archived",
      "value": true
    },
    {
      "key": "registration",
      "value": "EXEMPT"
    },
    {
      "key": "isCarrier",
      "value": true
    }
  ]
}

Sample Response

200 Created

[
  {
    "key": "archived",
    "success": true,
    "errors": []
  },
  {
    "key": "isCarrier",
    "success": true,
    "errors": []
  },
  {
    "key": "registration",
    "success": true,
    "errors": []
  }
]

Additional Information

Material Classification: LIQUID, DRY, GAS.
Type: FERTILIZER, MANURE.

Tank Mixes Endpoints

Retrieve tank mixes for an org

GET

/organizations/{organizationId}/tankMixes

This endpoint will retrieve tank mixes for an org.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
embed	array	The list of Rels, for which objects should be included in the response payload. Allowed Values: chemical	query
recordFilter	string	Filter results based on status Example: active, archived, all	query

Response Details

Field	Type	Description & 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
@type	string	The type of the tank mix. Example: TankMix
name	string	The name of the tank mix. Example: TankMix_with_All_Crop
orgUniqueId^DEPRECATED	string	The unique identifier for the organization. Example: 0585cd6d-898a-4298-ac09-a61db88d9e7d
solutionRate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The value of the measurement as a double. Example: 100
vrDomainId	string	The domain ID for the measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the value. Example: gal1ac-1
volume	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The volume value as a double. Example: 1200
vrDomainId	string	The domain ID for the volume measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the volume. Example: gal
carrier	object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 90
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the rate. Example: gal1ac-1
chemical	object	---
@type	string	The type of the chemical/fertilizer. Example: Fertilizer
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd
id	string	The identifier for the chemical/fertilizer. Example: 3678dedb-55d4-4c6a-a93a-24e909c70bfd
name	string	The name of the chemical/fertilizer. Example: 28-0-0 UAN
type	string	The type of the chemical/fertilizer. Example: FERTILIZER
category	string	The category of the chemical/fertilizer. Example: FERTILIZER
companyName	string	The name of the company. Example: BASF
epaRegistration^DEPRECATED	string	The EPA registration status. Example: EXEMPT
registration	string	The registration status. Example: EXEMPT
materialClassification	string	The material classification. Example: LIQUID
createdTime^DEPRECATED	string	The time when the chemical/fertilizer was created. Example: 2024-11-07T06:47:38.220Z
carrierId	string	The carrier ID. Example: 274bbd7b-24ae-11ee-9389-123df1de64f7
referenceId^DEPRECATED	string	The reference ID. Example: 3678dedb-55d4-4c6a-a93a-24e909c70bfd
referenceGuid	string	The reference GUID. Example: 3678dedb-55d4-4c6a-a93a-24e909c70bfd
carrier	boolean	Whether the chemical/fertilizer is a carrier. Example: true
archived	boolean	Whether the chemical/fertilizer is archived. Example: false
restrictedUse	boolean	Whether the chemical/fertilizer is restricted use. Example: false
agencyRegistrations^DEPRECATED	Array of object	---
@type	string	The type of the agency registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID. Example: EXEMPT
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: fertilizer
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd
components	Array of object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 10
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the rate. Example: gal1ac-1
chemical	object	---
@type	string	The type of the chemical/fertilizer. Example: Chemical
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
id	string	The identifier for the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
name	string	The name of the chemical/fertilizer. Example: TELIA
type	string	The type of the chemical/fertilizer. Example: FUNGICIDE
category	string	The category of the chemical/fertilizer. Example: CHEMICAL
companyName	string	The name of the company. Example: BASF
epaRegistration^DEPRECATED	string	The EPA registration status. Example: EXEMPT
registration	string	The registration status. Example: EXEMPT
modifiedTime^DEPRECATED	string	The time when the chemical/fertilizer was modified. Example: 2024-08-21T09:25:24.220763Z
carrierId	string	The carrier ID. Example: 58984d7a-126e-4d31-98e9-1ed65a582d91
referenceId^DEPRECATED	string	The reference ID. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
referenceGuid	string	The reference GUID. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
carrier	boolean	Whether the chemical/fertilizer is a carrier. Example: true
archived	boolean	Whether the chemical/fertilizer is archived. Example: false
restrictedUse	boolean	Whether the chemical/fertilizer is restricted use. Example: false
agencyRegistrations^DEPRECATED	Array of object	---
@type	string	The type of the agency registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID. Example: EXEMPT
notes	string	Notes about the tank mix. Example: this is tankmix notes
archived	boolean	Whether or not this tank mix is actively used. Example: false
createdTime^DEPRECATED	string	The time when the tank mix was created. Example: 2024-11-07T06:47:39.246Z
modifiedTime^DEPRECATED	string	The time when the tank mix was modified. Example: 2024-11-07T06:47:39.246Z
materialClassification	string	Material classification of the tank mix. Example: LIQUID
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/123456/tankMixes/0585cd6d-898a-4298-ac09-a61db88d9e7d

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/tankMixes"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/tankMixes?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 20,
  "values": [
    {
      "@type": "TankMix",
      "name": "TankMix_with_All_Crop",
      "orgUniqueId": "0585cd6d-898a-4298-ac09-a61db88d9e7d",
      "solutionRate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 100,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal1ac-1"
      },
      "volume": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 1200,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal"
      },
      "carrier": {
        "@type": "TankMixComponent",
        "rate": {
          "@type": "MeasurementAsDouble",
          "valueAsDouble": 90,
          "vrDomainId": "vrSolutionRateLiquid",
          "unit": "gal1ac-1"
        },
        "chemical": {
          "@type": "Fertilizer",
          "links": [
            {
              "@type": "Link",
              "rel": "self",
              "uri": "https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
            }
          ],
          "id": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "name": "28-0-0 UAN",
          "type": "FERTILIZER",
          "category": "FERTILIZER",
          "companyName": "---",
          "epaRegistration": "EXEMPT",
          "registration": "EXEMPT",
          "materialClassification": "LIQUID",
          "createdTime": "2024-11-07T06:47:38.220Z",
          "carrierId": "274bbd7b-24ae-11ee-9389-123df1de64f7",
          "referenceId": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "referenceGuid": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "carrier": true,
          "archived": false,
          "restrictedUse": false,
          "agencyRegistrations": [
            {
              "@type": "AgencyRegistration",
              "links": [
                {
                  "@type": "Link",
                  "rel": "agency",
                  "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                }
              ],
              "registrationId": "EXEMPT"
            }
          ],
          "activeIngredients": [],
          "availableRegistrations": [],
          "documentsList": []
        },
        "links": [
          {
            "@type": "Link",
            "rel": "fertilizer",
            "uri": "https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
          }
        ]
      },
      "components": [
        {
          "@type": "TankMixComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 10,
            "vrDomainId": "vrSolutionRateLiquid",
            "unit": "gal1ac-1"
          },
          "chemical": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
              }
            ],
            "id": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "name": "TELIA",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "modifiedTime": "2024-08-21T09:25:24.220763Z",
            "carrierId": "58984d7a-126e-4d31-98e9-1ed65a582d91",
            "referenceId": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "referenceGuid": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "carrier": true,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
            }
          ]
        }
      ],
      "notes": "",
      "archived": false,
      "createdTime": "2024-11-07T06:47:39.246Z",
      "modifiedTime": "2024-11-07T06:47:39.246Z",
      "materialClassification": "LIQUID",
      "targetCrops": [
        "ALFALFA",
        "CORN_WET"
      ],
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/tankMixes/0585cd6d-898a-4298-ac09-a61db88d9e7d"
        }
      ]
    },
    {
      "@type": "TankMix",
      "name": "214_tankmix",
      "orgUniqueId": "2a9a49ff-fd46-4a1f-a83d-7ce27f9c831e",
      "solutionRate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 100,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal1ac-1"
      },
      "volume": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 1200,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal"
      },
      "carrier": {
        "@type": "TankMixComponent",
        "rate": {
          "@type": "MeasurementAsDouble",
          "valueAsDouble": 100,
          "vrDomainId": "vrSolutionRateLiquid",
          "unit": "gal1ac-1"
        },
        "chemical": {
          "@type": "Fertilizer",
          "links": [
            {
              "@type": "Link",
              "rel": "self",
              "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
            }
          ],
          "id": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "name": "28-0-0 UAN",
          "type": "FERTILIZER",
          "category": "FERTILIZER",
          "companyName": "---",
          "epaRegistration": "EXEMPT",
          "registration": "EXEMPT",
          "materialClassification": "LIQUID",
          "createdTime": "2024-11-07T06:47:38.220Z",
          "carrierId": "274bbd7b-24ae-11ee-9389-123df1de64f7",
          "referenceId": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "referenceGuid": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
          "carrier": true,
          "archived": false,
          "restrictedUse": false,
          "agencyRegistrations": [
            {
              "@type": "AgencyRegistration",
              "links": [
                {
                  "@type": "Link",
                  "rel": "agency",
                  "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                }
              ],
              "registrationId": "EXEMPT"
            }
          ],
          "activeIngredients": [],
          "availableRegistrations": [],
          "documentsList": []
        },
        "links": [
          {
            "@type": "Link",
            "rel": "fertilizer",
            "uri": "https://sandboxapi.deere.com/platform/organizations/123456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
          }
        ]
      },
      "components": [
        {
          "@type": "TankMixComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 0,
            "vrDomainId": "vrSolutionRateLiquid",
            "unit": "gal1ac-1"
          },
          "chemical": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
              }
            ],
            "id": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "name": "Maybach",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "referenceId": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "referenceGuid": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "carrier": false,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
            }
          ]
        }
      ],
      "notes": "",
      "archived": false,
      "createdTime": "2024-11-07T06:48:29.403Z",
      "materialClassification": "LIQUID",
      "targetCrops": [
        "ALMONDS"
      ],
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/123456/tankMixes/2a9a49ff-fd46-4a1f-a83d-7ce27f9c831e"
        }
      ]
    }
  ]
}

Create a tank mix

POST

/organizations/{organizationId}/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: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
@type	string	The type of the tank mix. Example: TankMix
name Required	string	The name of the tank mix. Example: TankMix_with_All_Crop
notes	string	Notes about the Tank mix. Example: Mix in the carrier last
solutionRate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The value of the measurement as a double. Example: 5
vrDomainId Required	string	The domain ID for the measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the value. Example: gal1ac-1
volume Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The volume value as a double. Example: 1200
vrDomainId Required	string	The domain ID for the volume measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the volume. Example: gal
carrier Required	object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 4.465466816647919
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the rate. Example: gal1ac-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link. Example: fertilizer
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/57fb0c12-257d-496c-84ef-e300012387d1
components Required	Array of object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 3
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateMass
unit Required	string	The unit of measure for the rate. Example: kg1ha-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link either fertilizer or chemical. Example: fertilizer
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/00ae89c2-2213-4f34-aa57-40cd0191023b
archived	boolean	Whether or not this tank mix is actively used. Example: false
materialClassification Required	string	Material classification of the tank mix. Example: LIQUID
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Request [JSON]

{
  "@type": "TankMix",
  "name": "TankMix_with_All_Crop",
  "orgUniqueId": "37eeb905-634f-43e4-9cca-dcc0f555f60e",
  "notes": "Mix in the carrier last",
  "solutionRate": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 5,
    "vrDomainId": "vrSolutionRateLiquid",
    "unit": "gal1ac-1"
  },
  "volume": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 1200,
    "vrDomainId": "vrSolutionRateLiquid",
    "unit": "gal"
  },
  "carrier": {
    "@type": "TankMixComponent",
    "rate": {
      "@type": "MeasurementAsDouble",
      "valueAsDouble": 4.465466816647919,
      "vrDomainId": "vrSolutionRateLiquid",
      "unit": "gal1ac-1"
    },
    "links": [
      {
        "@type": "Link",
        "rel": "fertilizer",
        "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/57fb0c12-257d-496c-84ef-e300012387d1"
      }
    ]
  },
  "components": [
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 3,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "kg1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "fertilizer",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/00ae89c2-2213-4f34-aa57-40cd0191023b"
        }
      ]
    },
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 2,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "l1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0162de38-b270-472b-b20a-956900a6b8bf"
        }
      ]
    },
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 3,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "l1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/01cfb82d-3618-4bf5-99eb-956900a6ec41"
        }
      ]
    }
  ],
  "sourceNode": "468fcde7-5d14-4bee-bedd-1a234234234",
  "archived": false,
  "materialClassification": "LIQUID",
  "targetCrops": [
    "CORN_WET",
    "ALFALFA"
  ],
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/254751/tankMixes/37eeb905-634f-43e4-9cca-dcc0f555f60e"
    }
  ]
}

Sample Response

201 Created
Location: https://sandboxapi.deere.com/platform/organizations/123456/tankMixes/11139377-60ab-451f-931e-1d0569f343f1

View a specific tank mix

GET

/organizations/{organizationId}/tankMixes/{id}

This endpoint will retrieve a specific tank mix.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path
id Required	string	TankMixes id. Example: 89220e2a-04af-4d03-82de-1ac9a4edfa4f	path
embed	string	Embeds extra information in the tank mix response Example: chemical	query

Response Details

Field	Type	Description & Example
@type	string	The type of the tank mix. Example: TankMix
name	string	The name of the tank mix. Example: TankMix_with_All_Crop
notes	string	Notes about the Tank mix. Example: Mix in the carrier last
solutionRate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The value of the measurement as a double. Example: 5
vrDomainId	string	The domain ID for the measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the value. Example: gal1ac-1
volume	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The volume value as a double. Example: 1200
vrDomainId	string	The domain ID for the volume measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the volume. Example: gal
carrier	object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 4.465466816647919
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit	string	The unit of measure for the rate. Example: gal1ac-1
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: fertilizer
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/57fb0c12-257d-496c-84ef-e300012387d1
components	Array of object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 3
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateMass
unit	string	The unit of measure for the rate. Example: kg1ha-1
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link either fertilizer or chemical. Example: fertilizer
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/00ae89c2-2213-4f34-aa57-40cd0191023b
archived	boolean	Whether or not this tank mix is actively used. Example: false
materialClassification	string	Material classification of the tank mix. Example: LIQUID
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

[
  {
    "@type": "TankMix",
    "name": "TankMix_with_All_Crop",
    "orgUniqueId": "0585cd6d-898a-4298-ac09-a61db88d9e7d",
    "solutionRate": {
      "@type": "MeasurementAsDouble",
      "valueAsDouble": 100,
      "vrDomainId": "vrSolutionRateLiquid",
      "unit": "gal1ac-1"
    },
    "volume": {
      "@type": "MeasurementAsDouble",
      "valueAsDouble": 1200,
      "vrDomainId": "vrSolutionRateLiquid",
      "unit": "gal"
    },
    "carrier": {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 90,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal1ac-1"
      },
      "chemical": {
        "@type": "Fertilizer",
        "links": [
          {
            "@type": "Link",
            "rel": "self",
            "uri": "https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
          }
        ],
        "id": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
        "name": "28-0-0 UAN",
        "type": "FERTILIZER",
        "category": "FERTILIZER",
        "companyName": "---",
        "epaRegistration": "EXEMPT",
        "registration": "EXEMPT",
        "materialClassification": "LIQUID",
        "createdTime": "2024-11-07T06:47:38.220Z",
        "carrierId": "274bbd7b-24ae-11ee-9389-123df1de64f7",
        "referenceId": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
        "referenceGuid": "3678dedb-55d4-4c6a-a93a-24e909c70bfd",
        "carrier": true,
        "archived": false,
        "restrictedUse": false,
        "agencyRegistrations": [
          {
            "@type": "AgencyRegistration",
            "links": [
              {
                "@type": "Link",
                "rel": "agency",
                "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
              }
            ],
            "registrationId": "EXEMPT"
          }
        ],
        "activeIngredients": [],
        "availableRegistrations": [],
        "documentsList": []
      },
      "links": [
        {
          "@type": "Link",
          "rel": "fertilizer",
          "uri": "https://sandboxapi.deere.com/platform/organizations/132456/fertilizers/3678dedb-55d4-4c6a-a93a-24e909c70bfd"
        }
      ]
    },
    "components": [
      {
        "@type": "TankMixComponent",
        "rate": {
          "@type": "MeasurementAsDouble",
          "valueAsDouble": 10,
          "vrDomainId": "vrSolutionRateLiquid",
          "unit": "gal1ac-1"
        },
        "chemical": {
          "@type": "Chemical",
          "links": [
            {
              "@type": "Link",
              "rel": "self",
              "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
            }
          ],
          "id": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
          "name": "TELIA",
          "type": "FUNGICIDE",
          "category": "CHEMICAL",
          "companyName": "BASF",
          "epaRegistration": "EXEMPT",
          "registration": "EXEMPT",
          "modifiedTime": "2024-08-21T09:25:24.220763Z",
          "carrierId": "58984d7a-126e-4d31-98e9-1ed65a582d91",
          "referenceId": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
          "referenceGuid": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
          "carrier": true,
          "archived": false,
          "restrictedUse": false,
          "agencyRegistrations": [
            {
              "@type": "AgencyRegistration",
              "links": [
                {
                  "@type": "Link",
                  "rel": "agency",
                  "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                }
              ],
              "registrationId": "EXEMPT"
            }
          ],
          "activeIngredients": [],
          "availableRegistrations": [],
          "documentsList": []
        },
        "links": [
          {
            "@type": "Link",
            "rel": "chemical",
            "uri": "https://sandboxapi.deere.com/platform/organizations/123456/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
          }
        ]
      }
    ],
    "notes": "",
    "archived": false,
    "createdTime": "2024-11-07T06:47:39.246Z",
    "modifiedTime": "2024-11-07T06:47:39.246Z",
    "materialClassification": "LIQUID",
    "targetCrops": [
      "ALFALFA",
      "CORN_WET"
    ],
    "links": [
      {
        "@type": "Link",
        "rel": "self",
        "uri": "https://sandboxapi.deere.com/platform/organizations/123456/tankMixes/0585cd6d-898a-4298-ac09-a61db88d9e7d"
      }
    ]
  }
]

Update a tank mix

PUT

/organizations/{organizationId}/tankMixes/{id}

This endpoint allows to update the metadata and the composition of a tank mix.

OAuth Scope Required: eq2

Request URI

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

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path
id Required	string	TankMixes id. Example: 89220e2a-04af-4d03-82de-1ac9a4edfa4f	path

Request Details

Field	Type	Description & Example
@type	string	The type of the tank mix. Example: TankMix
name Required	string	The name of the tank mix. Example: TankMix_with_All_Crop
notes	string	Notes about the Tank mix. Example: Mix in the carrier last
solutionRate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The value of the measurement as a double. Example: 5
vrDomainId Required	string	The domain ID for the measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the value. Example: gal1ac-1
volume Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The volume value as a double. Example: 1200
vrDomainId Required	string	The domain ID for the volume measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the volume. Example: gal
carrier Required	object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 4.465466816647919
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the rate. Example: gal1ac-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link. Example: fertilizer
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/57fb0c12-257d-496c-84ef-e300012387d1
components Required	Array of object	---
@type	string	The type of the tank mix component. Example: TankMixComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 3
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateMass
unit Required	string	The unit of measure for the rate. Example: kg1ha-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link either fertilizer or chemical. Example: fertilizer
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/00ae89c2-2213-4f34-aa57-40cd0191023b
archived	boolean	Whether or not this tank mix is actively used. Example: false
materialClassification Required	string	Material classification of the tank mix. Example: LIQUID
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Request [JSON]

{
  "@type": "TankMix",
  "name": "TankMix_with_All_Crop",
  "orgUniqueId": "37eeb905-634f-43e4-9cca-dcc0f555f60e",
  "solutionRate": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 5,
    "vrDomainId": "vrSolutionRateLiquid",
    "unit": "gal1ac-1"
  },
  "volume": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 1200,
    "vrDomainId": "vrSolutionRateLiquid",
    "unit": "gal"
  },
  "carrier": {
    "@type": "TankMixComponent",
    "rate": {
      "@type": "MeasurementAsDouble",
      "valueAsDouble": 4.465466816647919,
      "vrDomainId": "vrSolutionRateLiquid",
      "unit": "gal1ac-1"
    },
    "links": [
      {
        "@type": "Link",
        "rel": "fertilizer",
        "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/57fb0c12-257d-496c-84ef-e300012387d1"
      }
    ]
  },
  "components": [
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 3,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "kg1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "fertilizer",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/00ae89c2-2213-4f34-aa57-40cd0191023b"
        }
      ]
    },
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 2,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "l1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0162de38-b270-472b-b20a-956900a6b8bf"
        }
      ]
    },
    {
      "@type": "TankMixComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 3,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "l1ha-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/01cfb82d-3618-4bf5-99eb-956900a6ec41"
        }
      ]
    }
  ],
  "sourceNode": "468fcde7-5d14-4bee-bedd-1a234234234",
  "archived": false,
  "materialClassification": "LIQUID",
  "targetCrops": [
    "ALFALFA",
    "CORN_WET"
  ],
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/254751/tankMixes/37eeb905-634f-43e4-9cca-dcc0f555f60e"
    }
  ]
}

Sample Response

204 No Content

Additional Information

Material Classification: LIQUID, DRY, GAS.
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.
Value as Double: Please refer to this link for possible formats of these rates.

Dry Blends Endpoints

Create a dry blend

POST

/organizations/{organizationId}/dryBlends

Add a dry blend to the asset list of an organization. Any chemicals or fertilizers in the dry blend must exist in the organization before the dry blend is persisted. The name of the dry blend must be unique in your organization.

Additionally, POST can be used for supporting offline creation of dry blends from e.g. a mobile app, by sending a payload with an `erid` generated by the client. If an `erid` is present in the payload, the service checks the database for that `erid`.

In case no record is found, a new one is created with that `erid` 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 `erid` already exists.

OAuth Scope Required: eq2

Request URI

POST https://sandboxapi.deere.com/platform/organizations/{organizationId}/dryBlends

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Request Details

Field	Type	Description & Example
DryBlend	object	---
@type	string	The type of the dry blend. Example: DryBlend
name Required	string	The name of the dry blend. Example: TestDryBlend
solutionRate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The value of the measurement as a double. Example: 0
vrDomainId Required	string	The domain ID for the measurement. Example: vrSolutionRateMass
unit Required	string	The unit of measure for the value. Example: lb1ac-1
materialClassification Required	string	Material classification of the dry blend. Example: DRY
archived	boolean	Whether or not this dry blend is actively used. Example: false
notes	string	Notes about the dry blend. Example: Mix in the carrier last
components Required	Array of object	---
@type	string	The type of the dry blend component. Example: DryBlendComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 100
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the rate. Example: gal1ac-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link either fertilizer or chemical. Example: chemical
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0d373fc5-d2a0-4afc-be6e-f8f34eabaaac
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Request [JSON]

{
  "@type": "DryBlend",
  "name": "TestDryBlend",
  "solutionRate": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 0,
    "vrDomainId": "vrSolutionRateMass",
    "unit": "lb1ac-1"
  },
  "materialClassification": "DRY",
  "archived": false,
  "notes": "Mix in the carrier last",
  "components": [
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 100,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal1ac-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0d373fc5-d2a0-4afc-be6e-f8f34eabaaac"
        }
      ]
    },
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 1.784,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "fertilizer",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/b25de35e-6062-4ecb-917d-ed145ab378d1"
        }
      ]
    }
  ],
  "targetCrops": [
    "CORN_WET",
    "ALFALFA"
  ]
}

Sample Response

201 Created
Location: https://sandboxapi.deere.com/platform/organizations/123456/dryBlends/11139377-60ab-451f-931e-1d0569f343f1

Retrieve dry blends for an org

GET

/organizations/{organizationId}/dryBlends

OAuth Scope Required: eq1

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{organizationId}/dryBlends

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

Parameters

Parameter	Type	Description & Example	In
embed	array	The list of Rels, for which objects should be included in the response payload. Allowed Values: product	query
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Response Details

Field	Type	Description & Example
@type	string	The type of the dry blend. Example: DryBlend
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/350519/dryBlends/af20cf1a-2def-47ce-9861-35f51afc1ad8
erid	string	The unique identifier for the dry blend. Example: af20cf1a-2def-47ce-9861-35f51afc1ad8
name	string	The name of the dry blend. Example: dryblend_alfa
solutionRate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The solution rate value as a double. Example: 10
vrDomainId	string	The domain ID for the solution rate measurement. Example: vrSolutionRateMass
unit	string	The unit of measure for the solution rate. Example: lb1ac-1
materialClassification	string	Material classification of the dry blend. Example: DRY
archived	boolean	Whether or not this dry blend is actively used. Example: false
notes	string	Notes about the dry blend. Example: notes
components	Array of object	---
@type	string	The type of the dry blend component. Example: DryBlendComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 5
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateMass
unit	string	The unit of measure for the rate. Example: lb1ac-1
product	object	---
@type	string	The type of the chemical/fertilizer. Example: Chemical
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
id	string	The unique identifier for the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
name	string	The name of the chemical/fertilizer. Example: TELIA
type	string	The type of the chemical/fertilizer. Example: FUNGICIDE
category	string	The category of the chemical/fertilizer. Example: CHEMICAL
companyName	string	The name of the company that manufactures the chemical/fertilizer. Example: BASF
epaRegistration	string	The EPA registration status of the chemical/fertilizer. Example: EXEMPT
registration	string	The registration status of the chemical/fertilizer. Example: EXEMPT
modifiedTime	string	The time when the chemical/fertilizer was last modified. Example: 2024-08-21T09:25:24.220763Z
carrierId	string	The carrier ID of the chemical/fertilizer. Example: 58984d7a-126e-4d31-98e9-1ed65a582d91
referenceId	string	The reference ID of the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
referenceGuid	string	The reference GUID of the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
carrier	boolean	Whether or not the chemical/fertilizer is a carrier. Example: true
archived	boolean	Whether or not the chemical/fertilizer is actively used. Example: false
restrictedUse	boolean	Whether or not the chemical/fertilizer is restricted use. Example: false
agencyRegistrations	Array of object	---
@type	string	The type of the agency registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID of the agency registration. Example: EXEMPT
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b539261-5e4b-4e1c-9201-3026f47109bb

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/dryBlends?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/dryBlends?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 20,
  "values": [
    {
      "@type": "DryBlend",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/350519/dryBlends/af20cf1a-2def-47ce-9861-35f51afc1ad8"
        }
      ],
      "erid": "af20cf1a-2def-47ce-9861-35f51afc1ad8",
      "name": "dryblend_alfa",
      "solutionRate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 10,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "materialClassification": "DRY",
      "archived": false,
      "notes": "notes",
      "components": [
        {
          "@type": "DryBlendComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 5,
            "vrDomainId": "vrSolutionRateMass",
            "unit": "lb1ac-1"
          },
          "product": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
              }
            ],
            "id": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "name": "TELIA",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "modifiedTime": "2024-08-21T09:25:24.220763Z",
            "carrierId": "58984d7a-126e-4d31-98e9-1ed65a582d91",
            "referenceId": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "referenceGuid": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
            "carrier": true,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
            }
          ]
        },
        {
          "@type": "DryBlendComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 5,
            "vrDomainId": "vrSolutionRateMass",
            "unit": "lb1ac-1"
          },
          "product": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
              }
            ],
            "id": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "name": "Maybach",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "referenceId": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "referenceGuid": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "carrier": false,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
            }
          ]
        }
      ],
      "targetCrops": [
        "ALFALFA",
        "ALMONDS"
      ]
    },
    {
      "@type": "DryBlend",
      "links": [
        {
          "@type": "Link",
          "rel": "self",
          "uri": "https://sandboxapi.deere.com/platform/organizations/350519/dryBlends/c0fac05d-a4e3-4c0d-9465-4a742ee08b11"
        }
      ],
      "erid": "c0fac05d-a4e3-4c0d-9465-4a742ee08b11",
      "name": "dryBlend_almond",
      "solutionRate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 10,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "materialClassification": "DRY",
      "archived": false,
      "notes": "detail notes",
      "components": [
        {
          "@type": "DryBlendComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 5,
            "vrDomainId": "vrSolutionRateMass",
            "unit": "lb1ac-1"
          },
          "product": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
              }
            ],
            "id": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "name": "Maybach",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "referenceId": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "referenceGuid": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
            "carrier": false,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
            }
          ]
        },
        {
          "@type": "DryBlendComponent",
          "rate": {
            "@type": "MeasurementAsDouble",
            "valueAsDouble": 5,
            "vrDomainId": "vrSolutionRateMass",
            "unit": "lb1ac-1"
          },
          "product": {
            "@type": "Chemical",
            "links": [
              {
                "@type": "Link",
                "rel": "self",
                "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/efe46183-f5e6-43a5-9ceb-3611adc03cc3"
              }
            ],
            "id": "efe46183-f5e6-43a5-9ceb-3611adc03cc3",
            "name": "LMA",
            "type": "FUNGICIDE",
            "category": "CHEMICAL",
            "companyName": "BASF",
            "epaRegistration": "EXEMPT",
            "registration": "EXEMPT",
            "referenceId": "efe46183-f5e6-43a5-9ceb-3611adc03cc3",
            "referenceGuid": "efe46183-f5e6-43a5-9ceb-3611adc03cc3",
            "carrier": false,
            "archived": false,
            "restrictedUse": false,
            "agencyRegistrations": [
              {
                "@type": "AgencyRegistration",
                "links": [
                  {
                    "@type": "Link",
                    "rel": "agency",
                    "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
                  }
                ],
                "registrationId": "EXEMPT"
              }
            ],
            "activeIngredients": [],
            "availableRegistrations": [],
            "documentsList": []
          },
          "links": [
            {
              "@type": "Link",
              "rel": "chemical",
              "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/efe46183-f5e6-43a5-9ceb-3611adc03cc3"
            }
          ]
        }
      ],
      "targetCrops": [
        "ALMONDS"
      ]
    }
  ]
}

Retrieves a specific dry blend

GET

/organizations/{organizationId}/dryBlends/{erid}

OAuth Scope Required: eq1

Request URI

GET https://sandboxapi.deere.com/platform/organizations/{organizationId}/dryBlends/{erid}

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

Parameters

Parameter	Type	Description & Example	In
embed	array	The list of Rels, for which objects should be included in the response payload. Allowed Values: product	query
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

Response Details

Field	Type	Description & Example
@type	string	The type of the dry blend. Example: DryBlend
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/350519/dryBlends/af20cf1a-2def-47ce-9861-35f51afc1ad8
erid	string	The unique identifier for the dry blend. Example: af20cf1a-2def-47ce-9861-35f51afc1ad8
name	string	The name of the dry blend. Example: dryblend_alfa
solutionRate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The solution rate value as a double. Example: 10
vrDomainId	string	The domain ID for the solution rate measurement. Example: vrSolutionRateMass
unit	string	The unit of measure for the solution rate. Example: lb1ac-1
materialClassification	string	Material classification of the dry blend. Example: DRY
archived	boolean	Whether or not this dry blend is actively used. Example: false
notes	string	Notes about the dry blend. Example: notes
components	Array of object	---
@type	string	The type of the dry blend component. Example: DryBlendComponent
rate	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble	number	The rate value as a double. Example: 5
vrDomainId	string	The domain ID for the rate measurement. Example: vrSolutionRateMass
unit	string	The unit of measure for the rate. Example: lb1ac-1
product	object	---
@type	string	The type of the chemical/fertilizer. Example: Chemical
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: self
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
id	string	The unique identifier for the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
name	string	The name of the chemical/fertilizer. Example: TELIA
type	string	The type of the chemical/fertilizer. Example: FUNGICIDE
category	string	The category of the chemical/fertilizer. Example: CHEMICAL
companyName	string	The name of the company that manufactures the chemical/fertilizer. Example: BASF
epaRegistration	string	The EPA registration status of the chemical/fertilizer. Example: EXEMPT
registration	string	The registration status of the chemical/fertilizer. Example: EXEMPT
modifiedTime	string	The time when the chemical/fertilizer was last modified. Example: 2024-08-21T09:25:24.220763Z
carrierId	string	The carrier ID of the chemical/fertilizer. Example: 58984d7a-126e-4d31-98e9-1ed65a582d91
referenceId	string	The reference ID of the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
referenceGuid	string	The reference GUID of the chemical/fertilizer. Example: a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d
carrier	boolean	Whether or not the chemical/fertilizer is a carrier. Example: true
archived	boolean	Whether or not the chemical/fertilizer is actively used. Example: false
restrictedUse	boolean	Whether or not the chemical/fertilizer is restricted use. Example: false
agencyRegistrations	Array of object	---
@type	string	The type of the agency registration. Example: AgencyRegistration
links	Array of object	---
@type	string	The type of the link. Example: Link
rel	string	The relationship of the link. Example: agency
uri	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7
registrationId	string	The registration ID of the agency registration. Example: EXEMPT
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
  "@type": "DryBlend",
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/350519/dryBlends/af20cf1a-2def-47ce-9861-35f51afc1ad8"
    }
  ],
  "erid": "af20cf1a-2def-47ce-9861-35f51afc1ad8",
  "name": "dryblend_alfa",
  "solutionRate": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 10,
    "vrDomainId": "vrSolutionRateMass",
    "unit": "lb1ac-1"
  },
  "materialClassification": "DRY",
  "archived": false,
  "notes": "notes",
  "components": [
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 5,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "product": {
        "@type": "Chemical",
        "links": [
          {
            "@type": "Link",
            "rel": "self",
            "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
          }
        ],
        "id": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
        "name": "TELIA",
        "type": "FUNGICIDE",
        "category": "CHEMICAL",
        "companyName": "BASF",
        "epaRegistration": "EXEMPT",
        "registration": "EXEMPT",
        "modifiedTime": "2024-08-21T09:25:24.220763Z",
        "carrierId": "58984d7a-126e-4d31-98e9-1ed65a582d91",
        "referenceId": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
        "referenceGuid": "a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d",
        "carrier": true,
        "archived": false,
        "restrictedUse": false,
        "agencyRegistrations": [
          {
            "@type": "AgencyRegistration",
            "links": [
              {
                "@type": "Link",
                "rel": "agency",
                "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
              }
            ],
            "registrationId": "EXEMPT"
          }
        ],
        "activeIngredients": [],
        "availableRegistrations": [],
        "documentsList": []
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/a3aaa1b4-6c5b-4b04-ac39-6d316be7fd8d"
        }
      ]
    },
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 5,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "product": {
        "@type": "Chemical",
        "links": [
          {
            "@type": "Link",
            "rel": "self",
            "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
          }
        ],
        "id": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
        "name": "Maybach",
        "type": "FUNGICIDE",
        "category": "CHEMICAL",
        "companyName": "BASF",
        "epaRegistration": "EXEMPT",
        "registration": "EXEMPT",
        "referenceId": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
        "referenceGuid": "dfbe700e-87cb-4362-a23b-ff5afd1ccd4a",
        "carrier": false,
        "archived": false,
        "restrictedUse": false,
        "agencyRegistrations": [
          {
            "@type": "AgencyRegistration",
            "links": [
              {
                "@type": "Link",
                "rel": "agency",
                "uri": "https://sandboxapi.deere.com/platform/agencies/8fb34898-64f5-5a1e-a698-34ab348220a7"
              }
            ],
            "registrationId": "EXEMPT"
          }
        ],
        "activeIngredients": [],
        "availableRegistrations": [],
        "documentsList": []
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/350519/chemicals/dfbe700e-87cb-4362-a23b-ff5afd1ccd4a"
        }
      ]
    }
  ],
  "targetCrops": [
    "ALFALFA"
  ]
}

Update a dry blend

PUT

/organizations/{organizationId}/dryBlends/{erid}

Allows updates to be made to the name, archival status, and components of a dry blend.

OAuth Scope Required: eq2

Request URI

PUT https://sandboxapi.deere.com/platform/organizations/{organizationId}/dryBlends/{erid}

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

Content-Type: application/vnd.deere.axiom.v3+json

Parameters

Parameter	Type	Description & Example	In
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

Request Details

Field	Type	Description & Example
DryBlend	object	---
@type	string	The type of the dry blend. Example: DryBlend
name Required	string	The name of the dry blend. Example: TestDryBlend
solutionRate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The value of the measurement as a double. Example: 0
vrDomainId Required	string	The domain ID for the measurement. Example: vrSolutionRateMass
unit Required	string	The unit of measure for the value. Example: lb1ac-1
materialClassification Required	string	Material classification of the dry blend. Example: DRY
archived	boolean	Whether or not this dry blend is actively used. Example: false
notes	string	Notes about the dry blend. Example: Mix in the carrier last
components Required	Array of object	---
@type	string	The type of the dry blend component. Example: DryBlendComponent
rate Required	object	---
@type	string	The type of the measurement. Example: MeasurementAsDouble
valueAsDouble Required	number	The rate value as a double. Example: 100
vrDomainId Required	string	The domain ID for the rate measurement. Example: vrSolutionRateLiquid
unit Required	string	The unit of measure for the rate. Example: gal1ac-1
links Required	Array of object	---
@type	string	The type of the link. Example: Link
rel Required	string	The relationship of the link either fertilizer or chemical. Example: chemical
uri Required	string	The URI of the linked resource. Example: https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0d373fc5-d2a0-4afc-be6e-f8f34eabaaac
targetCrops	Array of string	The name of the crop that this variety is associated with. Example: CORN_WET,ALFALFA

Sample Request [JSON]

{
  "name": "TestDryBlend",
  "solutionRate": {
    "@type": "MeasurementAsDouble",
    "valueAsDouble": 0,
    "vrDomainId": "vrSolutionRateMass",
    "unit": "lb1ac-1"
  },
  "materialClassification": "DRY",
  "archived": false,
  "notes": "Mix in the carrier last",
  "components": [
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 100,
        "vrDomainId": "vrSolutionRateLiquid",
        "unit": "gal1ac-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "chemical",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/chemicals/0d373fc5-d2a0-4afc-be6e-f8f34eabaaac"
        }
      ]
    },
    {
      "@type": "DryBlendComponent",
      "rate": {
        "@type": "MeasurementAsDouble",
        "valueAsDouble": 1.784,
        "vrDomainId": "vrSolutionRateMass",
        "unit": "lb1ac-1"
      },
      "links": [
        {
          "@type": "Link",
          "rel": "fertilizer",
          "uri": "https://sandboxapi.deere.com/platform/organizations/254751/fertilizers/b25de35e-6062-4ecb-917d-ed145ab378d1"
        }
      ]
    }
  ],
  "targetCrops": [
    "CORN_WET"
  ]
}

Sample Response [JSON]: Header

204 No Content

Companies Endpoints

Retrieve product companies for an org.

GET

/organizations/{organizationId}/productCompanies

A unified list of custom and reference product companies in your organization.

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
organizationId Required	integer	The identifier of the Organization. Example: 6781	path

Response Details

Field	Type	Description & Example
companyName	string	The name of the input manufacturer for chemical, fertilizer or variety. Example: Monsanto
@type	---	--- Example: ProductCompany

Sample Response [JSON]

200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/productCompanies?itemLimit=10&pageOffset=0"
    },
    {
      "@type": "Link",
      "rel": "nextPage",
      "uri": "https://sandboxapi.deere.com/platform/organizations/123456/productCompanies?itemLimit=10&pageOffset=10"
    }
  ],
  "total": 1439,
  "values": [
    {
      "@type": "ProductCompany",
      "companyName": "Mosaic"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Howard Fertilizer"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Citizens LLC"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Diamond K"
    },
    {
      "@type": "ProductCompany",
      "companyName": "The JC Smith Co"
    },
    {
      "@type": "ProductCompany",
      "companyName": "BH Hybrids"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Garlic Research Labs"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Atlantic - Pacific Agricultural Co., Inc."
    },
    {
      "@type": "ProductCompany",
      "companyName": "Crites Seeds Inc"
    },
    {
      "@type": "ProductCompany",
      "companyName": "Quality Borate Company"
    }
  ]
}

Active Ingredients Endpoints

List of available active ingredients

GET

/activeIngredients

Returns a list of all available active ingredients.

OAuth Scope Required: eq1

Request URI

GET https://sandboxapi.deere.com/isg/activeIngredients

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

Parameters

Parameter	Type	Description & Example	In
entityType	string	Filters the results by the provided entity type. Example: CHEMICAL Allowed Values: CHEMICAL,FERTILIZER	query

Response Details

Field	Type	Description & Example
@type	string	--- Example: ActiveIngredient
id	string	The primary identifier of the active ingredient. Example: 30ca101c-e78f-4e45-a248-1ce9622c7f10
name	string	The name of the active ingredient. Example: Urea Nitrogen

Sample Response [JSON]

{
  "links": [
    {
      "@type": "Link",
      "rel": "self",
      "uri": "https://sandboxapi.deere.com/isg/activeIngredients"
    }
  ],
  "total": 4,
  "values": [
    {
      "@type": "ActiveIngredient",
      "id": "30ca101c-e78f-4e45-a248-1ce9622c7f10",
      "name": "Urea Nitrogen"
    },
    {
      "@type": "ActiveIngredient",
      "id": "e022ec44-43de-43ab-92e2-2c60da7762b9",
      "name": "1-aminocyclopropanecarboxylic acid"
    },
    {
      "@type": "ActiveIngredient",
      "id": "fa79f870-7aa1-48e7-9d1e-4cf98d68ca57",
      "name": "1-aminocyclopropanecarboxylic acid (ACC)"
    },
    {
      "@type": "ActiveIngredient",
      "id": "962bd78a-0029-4c6a-b2dd-2efab3f53285",
      "name": "1-Methylcyclopropene"
    }
  ]
}

Documents Endpoints

Document details w/ pdf file

GET

/documents/{erid}

Document details for a product with embedded pdf file (gzip+base64).

OAuth Scope Required: eq1

Request URI

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

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

Parameters

Parameter	Type	Description & Example	In
erid Required	string	A unique identifier for an entity formatted as a uuid.	path

Response Details

Field	Type	Description & Example
@type	string	The type of the document. Example: Document
erid	string	The unique identifier for the document. Example: cff5ba0b-1768-48a3-b3ec-dd62aac1cff3
productErid	string	The unique identifier for the product associated with the document. Example: 7d9ec6a6-6b8f-4312-92c7-bc022b7f5351
fileName	string	The name of the file. Example: ld8NF004.pdf
docType	string	The type of the document. Example: Specimen Label
description	string	A description of the document. Example: SAL 7/27/11
expirationDate	string	--- Example: 2017-03-22
pdfFile	string	The pdf file of the document after compression (gzip) and encoding (base64) Example: H4sIAAAAAAAAAIy7BVhduxI2XNy1aLFNcYe9cXd3l01xd3eKuzsUd5fiBYq7u0OLe6G4f+05175z7n+/f60nzySTWZPJ5J1kW...

Sample Response [JSON]

{
  "@type": "Document",
  "erid": "cff5ba0b-1768-48a3-b3ec-dd62aac1cff3",
  "productErid": "7d9ec6a6-6b8f-4312-92c7-bc022b7f5351",
  "fileName": "ld8NF004.pdf",
  "docType": "Specimen Label",
  "description": "SAL 7/27/11",
  "pdfFile": "H4sIAAAAAAAAAIy7BVhduxI2XNy1aLFNcYe9cXd3l01xd3eKuzsUd5fiBYq7u0OLe6G4f+05175z7n+/f60nzySTWZPJ5J1kW..."
}

vrTillageDepthTarget

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

Units

Unit Of Measure	Digits	Decimal	Min Value	Max Value	Measurement System
in	3	1	-100.0	100.0	English
cm	3	1	-254.0	254.0	Metric
in	3	1	-100.0	100.0	Mixed

vrSeedRateMassTarget

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

Units

Unit Of Measure	Digits	Decimal	Max Value	Measurement System
lb1ac-1	5	1	99999.9	English
ton1ac-1	5	1	99999.9	English
lb1[ft2]-1	5	1	99999.9	English
kg1ha-1	5	1	99999.9	Metric
t1ha-1	5	1	99999.9	Metric
kg1[m2]-1	5	1	99999.9	Metric
lb1ac-1	5	1	99999.9	Mixed
kg1[ft2]-1	5	1	99999.9	Mixed
kg1ac-1	5	1	99999.9	Mixed

vrSeedRateSeedsTarget

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

Units

Unit Of Measure	Digits	Decimal	Min Value	Max Value	Measurement System
seeds1ac-1	8	0	0	99999999	English
thndSeeds1ac-1	6	1	0.0	100000.0	English
seeds1[ft2]-1	4	1	0.0	9999.9	English
seeds1ha-1	8	0	0	99999999	Metric
thndSeeds1ha-1	6	1	0.0	100000.0	Metric
seeds1[m2]-1	4	1	0.0	9999.9	Metric
seeds1ac-1	8	0	0	99999999	Mixed
seeds1[ft2]-1	4	1	0.0	9999.9	Mixed

vrAppRateMassTarget

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

Units

Unit Of Measure	Digits	Decimal	Min Value	Max Value	Measurement System
lb1ac-1	5	2	0.00	99999.99	English
ton1ac-1	5	2	0.00	99999.99	English
ozm1ac-1	5	2	0.00	99999.99	English
ozm1[ft2]-1	4	2	0.00	9999.99	English
kg1ha-1	5	2	0.00	99999.99	Metric
t1ha-1	5	2	0.00	99999.99	Metric
g1ha-1	5	2	0.00	99999.99	Metric
mg1ha-1	5	2	0.00	99999.99	Metric
dg1ha-1	5	2	0.00	99999.99	Metric
dg1[mm2]-1	5	1	0.0	99999.9	Metric
mg1[m2]-1	4	0	0	9999	Metric
g1[m2]-1	4	0	0	9999	Metric
kg1[m2]-1	5	2	0.00	99999.99	Metric
lb1ac-1	5	2	0.00	99999.99	Mixed
kg1ac-1	5	2	0.00	99999.99	Mixed
ton1ac-1	5	2	0.00	99999.99	Mixed
ozm1ac-1	5	2	0.00	99999.99	Mixed
t1ac-1	5	2	0.00	99999.99	Mixed
g1ac-1	5	2	0.00	99999.99	Mixed
mg1ac-1	5	2	0.00	99999.99	Mixed
dg1ac-1	5	2	0.00	99999.99	Mixed

vrAppRateVolumeTarget

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

Units

Unit Of Measure	Digits	Decimal	Max Value	Measurement System
gal1ac-1	5	2	99999.99	English
qt1ac-1	5	2	99999.99	English
pt1ac-1	5	2	99999.99	English
floz1ac-1	5	2	99999.99	English
l1ha-1	6	2	935395.53	Metric
ml1ha-1	5	2	99999.99	Metric
kl1ha-1	5	2	99999.99	Metric
ul1ha-1	5	2	99999.99	Metric
dl1ha-1	5	2	99999.99	Metric
[m3]1ha-1	5	2	99999.99	Metric
gal1ac-1	5	2	99999.99	Mixed
kl1ac-1	5	2	99999.99	Mixed
qt1ac-1	5	2	99999.99	Mixed
pt1ac-1	5	2	99999.99	Mixed
floz1ac-1	5	2	99999.99	Mixed
ul1ac-1	5	2	99999.99	Mixed
ml1ac-1	5	2	99999.99	Mixed
l1ac-1	5	2	99999.99	Mixed
dl1ac-1	5	2	99999.99	Mixed

vrSolutionRateLiquid

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

Units

Unit Of Measure	Digits	Decimal	Min Value	Max Value	Measurement System
gal1ac-1	5	3	0.000	99999.999	English
qt1ac-1	5	2	0.00	99999.99	English
pt1ac-1	5	2	0.00	99999.99	English
floz1ac-1	5	2	0.00	99999.99	English
l1ha-1	5	3	0.000	99999.999	Metric
ml1ha-1	5	2	0.00	99999.99	Metric
kl1ha-1	5	2	0.00	99999.99	Metric
ul1ha-1	5	2	0.00	99999.99	Metric
dl1ha-1	5	2	0.00	99999.99	Metric
[m3]1ha-1	5	2	0.00	99999.99	Metric
gal1ac-1	5	3	0.000	99999.999	Mixed
kl1ac-1	5	2	0.00	99999.99	Mixed
qt1ac-1	5	2	0.00	99999.99	Mixed
pt1ac-1	5	2	0.00	99999.99	Mixed
floz1ac-1	5	2	0.00	99999.99	Mixed
ul1ac-1	5	2	0.00	99999.99	Mixed
ml1ac-1	5	2	0.00	99999.99	Mixed
l1ac-1	5	2	0.00	99999.99	Mixed
dl1ac-1	5	2	0.00	99999.99	Mixed

dtProjectionType

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

Values

Defined type value	Calculation Method
dtiProjectionDeere	Deere
dtiNonJohnDeere1	BeeLine
dtiNonJohnDeere2	Trimble

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

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.

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.
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.
Sample Response [JSON]
{ "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" ] }

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.

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:

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.
The customer is redirected to the John Deere sign-in page.
The customer signs into John Deere, and the request is redirected back to the authorization server.
The customer is then presented with the scope allowance screen. (During first token request, or with modified scopes)
Scope acceptance is sent back to the OAuth server, and the customer is then redirected back to the client application with the authorization code.

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).
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}
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
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.
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.
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.
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.
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.

Download and install Postman on your computer (link above), or you may use the web version.
Open Postman, click on Settings at the top, and in General settings turn off all of the Headers options.
In the top nav section of the Postman client application, you can hit the + sign to add a new request to your console.
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.
The screen will change, and you will see Type is set as OAuth 2.0.
Add auth data to should be set as Request Headers.
Header Prefix should be set as Bearer.
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).

Add a Token Name (can be anything).
Leave the Grant Type as Authorization Code.
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.
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.
For the Client ID and Client Secret Developer.Deere.com, login, and access your application profile in the "My Applications" section.

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.

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.
State is an opaque value to prevent cross-site forgery. Enter any unique string in this box (ex. 12345).
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)

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).

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.

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)
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)
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.
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.

Paging

When a Precision Tech API returns a collection of objects, it wraps the response in a CollectionPage object. This wrapper object has three properties:

Integer total: An integer value that represents the number of available values.
List<Link> links: A collection of links. If the response was paginated, this will contain 'nextPage' and 'previousPage' links.
List<T> values: The actual object values returned by the API.

By default, collections are paginated. Each page of data contains 10 values. The response will contain nextPage and previousPage links, which can be followed to view the entire response. The last page of data will not have a nextPage link. Please note that not all responses from each API are paginated or accept the page size parameters below.

Page Item Limit

You can control the page size by adding an itemLimit parameter to your request url. The value for this parameter should be in multiples of 10 up to 100 (max limit). You can set this by appending ?itemLimit=100 to the end of the request url.

Page Offset

You can control what page the response begins with by adding a pageOffset parameter to your request url. You can set this by appending ?pageOffset=0 to the end of the request url. The value used for this parameter should be in line with the item limit you are requesting. By default the page size is 10, so when not using the itemLimit parameter, this value should be in multiples of 10 (10,20,30, etc.). If you are using an itemLimit of 100, the value should be in multiples of 100 (100,200,300, etc.)

Disabling Paging

If you prefer, you can disable pagination entirely. The API response will still wrap responses in a CollectionPage object, but you would receive the entire collection at once. To disable pagination, add a request header named x-deere-no-paging and set its value to true. If you will be repeatedly polling an endpoint for updated data, consider using eTags instead of disabling pagination.

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:

Include x-deere-signature as a request header.
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
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.
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.

Sample Request with eTag Header

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

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

Sample Response Header with String 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

Sample Request with eTag & String Token

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

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

Sample Response: No Changes

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

List- supports ordered list and unordered list (bullets will not render on UI)
Paragraph
Strong
Italic
Line Break
Horizontal Rule
Links

Map Layer Summary POST

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

Sample text with Markdown

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).

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

Sample measurementData with Markdown

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

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.

Sample Response [JSON]

{
  "@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.