Getting Started

Goodyear provides a set of APIs to facilitate key systems integrations with partner systems. This site provides an overview of core capabilities available via Goodyear’s APIs. Users will need to login to access the documentation for available APIs. Additional capabilities and custom integrations can be setup on an as-needed basis. Contact the Goodyear team to learn more about custom integration needs outside the scope of the provided APIs.

Documentation and Site Access

To access the full Goodyear API documentation, start by creating an account using the Sign Up button in the navigation bar. After verifying your email address, reach out to the Goodyear team to request access. Approval is required to unlock full site access and view all API documentation.

Base Url

Each integration partner will be provided a base url in the following format

https://gaas.goodyear.com/{partnerName}/{env}

Authentication

All API calls to the GaaS system require authentication via bearer token. Each integration partner will receive a unique client id an client secret to use for authentication. Additionally, the Goodyear team will provide the correct resource id to use for each integration. Bearer token's can be obtained from the following URL:

https://login.microsoftonline.com/goodyearcorp.onmicrosoft.com/oauth2/token

Microsoft will then respond with a JSON object with the property "access_token". This property can be used for subsequent calls.

Tokens expire after 60 minutes. Partner's are encouraged to generate a new authentication token for each call to avoid unintended authorization issues.

curl --location 'https://login.microsoftonline.com/goodyearcorp.onmicrosoft.com/oauth2/token' \

--header 'Content-Type: application/x-www-form-urlencoded' \

--data-urlencode 'grant_type=client_credentials' \

--data-urlencode 'client_id=YOUR_CLIENT_ID' \

--data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \

--data-urlencode 'resource=YOUR_RESOURCE_APP_ID_URI'

Additional information regarding the authentication token request and response structure can be viewed on Microsoft's website.

Dictionary of Key Terms

nonSig -> Also known as nonSigCode. Acts as a unique identifier for a location in the Goodyear system. Most often associated with a Goodyear store location

entry -> Typically represents a line on an order. Each entry typically has product, quantity, and price information

entryType -> Denotes the type of entry. Valid values are TIRES, PART, or SERVICE

productCode -> Unique identifier for a Goodyear product or service

blocks -> Within the context of appointment availability, each block represents a segmented block of time that an appointment could be scheduled for. Appointment blocks are associated within a specific bay in a Goodyear store depending on the product or service the appointment is made for.

If any fields in the Goodyear documentation are unclear or unknown, please reach out to the Goodyear team for clarification.

Pagination

Multiple endpoints within the Goodyear API suite allow for the retrieval of a large amount of records. In these cases, pagination is used to limit the number of records per request and provide better overall system performance.

Pagination API calls typically have three query params:

pagination (boolean) -> Toggle to enable or disable pagination. Pagination is enabled by default

pageNumber (int) -> Specify which page of records to retrieve

pageSize (int) -> Specify the number of records to return in each page

Pagination responses contain three fields to help users navigate between pages and determine if there are more records available:

moreAvailable (boolean) -> Specifies if there are more records available on the next page

pageNumber (int) -> Specifies the current page