openapi: 3.0.0
info:
  version: 1.2.1
  title: Emerge Public API
  description: 'The Emerge public API provides partner developers with access to core capabilities of the Emerge platform.


    The current version of the API is v1.2.1. This API will evolve as the features in Emerge''s product evolve.


    # Get Started


    The Emerge API is a ''restish'' API and is designed to allow you to work with objects using familiar HTTP verbs like

    * POST

    * PUT

    * DELETE

    * GET


    All production level API requests are made to:

    <br />`https://api.emergemarket.io`



    The testing sandbox is available during development and for testing:

    <br />`https://demo-api.emergemarket.dev/`


    ## Compatibility Policy


    Emerge APIs are versioned using a prefix in the endpoint URL. Within an API version, we only make backward-compatible
    changes. This mean that when a provider integrates with our REST API, the API will continue to work until the version
    is deprecated. If we have to create a change that is not compatible with the current version, a new version will be created.


    ### Non-Breaking Changes


    * Adding additional optional fields on the API request.

    * Adding additional fields on the API response.

    * Adding an HTTP method to an API.

    * Adding optional headers.

    * Adding additional accepted enumerated values.

    * Changing Error Response descriptions.

    * Added Rate Limits.


    ### Breaking Changes


    * Removing or renaming an API method or endpoint.

    * Removing or renaming existing API request or response fields.

    * Removing or renaming enumerated values.

    * Changing the Error Response values.


    ### Deprecation Policy


    * Emerge will continue to support deprecated APIs for 1 year.

    * Documentation will also be updated and integrating providers will be notified via email when a version or endpoint is
    being deprecated.


    # Workflows

    The Emerge API is designed to support two primary workflows for a shipper organization: An opportunity-to-tender workflow
    and an opportunity-to-award workflow.


    ## Opportunity-to-tender


    The opportunity-to-tender is the most common workflow of an integrating system. In this workflow, the Emerge system is
    used to source the live capacity as well as to tender through Emerge to that live capacity. The benefit of this workflow
    is that all information, from opportunity through tender and finally tracking is maintained in the Emerge system. The
    basic steps of this workflow include:


    1. Create an Opportunity.


    2. Post to the shipper''s (your) marketplace.


    3. Receive options from carriers. Retrieval is achieved through a webhook published by you for receiving option events.


    4. Tender to a carrier.


    5. Get tracking updates through webhook.


    ## Opportunity-to-award

    The opportunity-to-award workflow supports customers who are using the Emerge platform in conjunction with their TMS.
    In this workflow, Emerge is used as a capacity provider while the TMS is used on the execution side. The basic steps of
    this workflow include:


    1. Create an opportunity.


    2. Post to the shipper''s (your) marketplace.


    3. Receive options from carriers. Retrieval is achieved through a webhook published by you for receiving option events.


    4. Award to a carrier.


    Note that awarding to the carrier will automatically close the opportunity, notify the carrier that they "won" the bidding
    and notify the remaining carriers that they did not win the bidding.


    The opportunity-to-award workflow requires that the customer''s TMS tenders to the winning carrier. This happens outside
    of the Emerge system.

    '
servers:
- url: https://api.emergemarket.io/v1
  description: Primary production endpoint
- url: https://demo-api.emergemarket.dev/v1
  description: Testing sandbox endpoint
tags:
- name: Webhooks
  description: "Webhooks are used to provide updates to the TMS when award or option events are generated within the Emerge\
    \ system.\n</br></br>If our webhook message cannot be accepted by the webhook endpoint due to network failures, server\
    \ errors, or request timeouts we will attempt delivering the message again. We will retry sending the message 6 times\
    \ with varying gaps of time. \nSee table below:\n<table>\n<tr>\n<th>Retry Count</th>\n<th>Time</th>\n</tr>\n<tr>\n<td>1</td>\n\
    <td>1 second from initial attempt</td>\n</tr>\n<tr>\n<td>2</td>\n<td>4 seconds from first attempt</td>\n</tr>\n<tr>\n\
    <td>3</td>\n<td>9 seconds from second  attempt</td>\n</tr>\n<tr>\n<td>4</td>\n<td>16 seconds from third attempt</td>\n\
    </tr>\n<tr>\n<td>5</td>\n<td>25 seconds from fourth attempt</td>\n</tr>\n<tr>\n<td>6</td>\n<td>36 seconds from fifth attempt</td>\n\
    </tr>\n</table>\t\t\n"
- name: Tracking Events
  description: "The tracking events share a common object structure with the exception of ‘event_data’ object, which can change\
    \ slightly depending on the updates.\n# Delivery Status Updated Event\n    <h3>delivery_status_updated</h3>\n    The delivery\
    \ status is the on-time status of a shipment. In the event that this changes from one status to another the user can be\
    \ notified (for example on-time to late, etc). This can be driven by the ETA being updated or the actual arrival/departure\
    \ being updated. The old state will be an empty object if there was no previous data (on creation).  \n<SchemaDefinition\
    \ schemaRef=\"#/components/schemas/delivery_status_updated_Event\" />\n\n# Tracking Status Updated Event\n    <h3>tracking_status_updated</h3>\n\
    \    The shipment status is the primary status of the shipment. This determines the shipments progress from tender accepted\
    \ > delivered. The old state will be an empty object if there was no previous data (on creation). \n<SchemaDefinition\
    \ schemaRef=\"#/components/schemas/tracking_status_updated_Event\" />\n\n# Stop Actual Times Updated Event\n    <h3>stop_actual_times_updated\
    \ </h3>\n    The user can be notified via this event when an actual arrival or departure information is received in the\
    \ Emerge system. The old state will be an empty object if there was no previous data (on creation). \n<SchemaDefinition\
    \ schemaRef=\"#/components/schemas/stop_actual_times_updated_Event\" />\n\n# Current Location Updated Job Event\n    <h3>current_location_updated_job\
    \ </h3>\n    Emerge will send the most recent location of the truck every 30 minutes. The old state will be an empty object\
    \ if there was no previous data (on creation). \n<SchemaDefinition schemaRef=\"#/components/schemas/current_location_updated_Event\"\
    \ />\n"
- name: Opportunity Awarded Event
  description: "<h3>opportunity_awarded</h3>\nThis object contains details of the Awarded option, so that the subscriber can\
    \ do the subsequent actions, including tendering to it, in their own TMS.\n <SchemaDefinition schemaRef=\"#/components/schemas/Opportunity_Awarded_Event\"\
    \ />\n"
- name: Options Changed Event
  description: "<h3>options_changed</h3>\nThis object contains the list of all the options available for a particular opportunity.\
    \ Showing all options or the lowest option can be controlled in the application setting. Whenever there is a change in\
    \ the available option(s), this event will get triggered and notify the subscribers.\n <SchemaDefinition schemaRef=\"\
    #/components/schemas/Options_Changed_Event\" />\n"
- name: Tender Status Updated Event
  description: "<h3>tender_status_updated</h3>\nThis object contains the tender details. Whenever there is a change in the\
    \ tender status, this event will get triggered and notify the subscribers.\n <SchemaDefinition schemaRef=\"#/components/schemas/Tender_Status_Updated_Event\"\
    \ />\n"
- name: Network Partner Updated Event
  description: "<h3>network_partner_updated </h3>\nThis object contains the partner details. Whenever the partner registers\
    \ on Emerge platform following an invite by a shipper,or there is a change in the partner details, this event will get\
    \ triggered and notify the subscribers\n <SchemaDefinition schemaRef=\"#/components/schemas/Network_Partner_Updated_Event\"\
    \ />\n"
- name: Network Partner Deleted Event
  description: "<h3>network_partner_deleted </h3>\nThis object contains the partner details. When the partner is deleted then\
    \ this event will get triggered and notify the subscribers.\n <SchemaDefinition schemaRef=\"#/components/schemas/Network_Partner_Deleted_Event\"\
    \ />\n"
- name: Current Marketplace Option Event
  description: "<h3>current_marketplace_option </h3>\nThis object contains the Current Marketplace Option. Whenever there\
    \ is a change in the Marketplace Option details this event will get triggered and notify the subscribers.\n <SchemaDefinition\
    \ schemaRef=\"#/components/schemas/Current_Marketplace_Option_Event\" />\n"
- name: Opportunity Deleted Event
  description: "<h3>opportunity_deleted </h3>\nThis object contains an opportunity identifier and references. When an opportunity\
    \ is deleted then this event will get triggered and notify the subscribers.\n <SchemaDefinition schemaRef=\"#/components/schemas/Opportunity_Deleted_Event\"\
    \ />\n"
- name: Opportunity Not Awarded Event
  description: "<h3>opportunity_not_awarded </h3>\nThis object contains an opportunity identifier and references. When an\
    \ opportunity is not awarded at the end of the bid duration then this event will get triggered and notify the subscribers.\n\
    \ <SchemaDefinition schemaRef=\"#/components/schemas/Opportunity_NotAwarded_Event\" />\n"
x-tagGroups:
- name: Shipper API
  tags:
  - Authentication
  - Network Partners
  - Opportunities
  - Options
  - Awards
  - Tenders
  - Shipments
- name: Webhook Subscription API
  tags:
  - Webhooks
- name: Webhook Events
  tags:
  - Tracking Events
  - Opportunity Awarded Event
  - Opportunity Deleted Event
  - Opportunity Not Awarded Event
  - Options Changed Event
  - Tender Status Updated Event
  - Network Partner Updated Event
  - Network Partner Deleted Event
  - Current Marketplace Option Event
paths:
  /auth/login:
    post:
      tags:
      - Authentication
      summary: Gets access token for shipper user.
      security: []
      description: This method allows the shipper user to generate an access token from Emerge platform. This access token
        is based upon a username/password combination that should be supplied in the request. Authentication has a rate limit
        of up to 20 requests per second. This limit may be lower during times of high volumes.
      requestBody:
        description: Request body of an authentication attempt.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_name:
                  description: The user name of the user authenticating against the API.
                  type: string
                  example: jsseh@emergemarket.com
                password:
                  description: The password of the user authenticating against the API.
                  type: string
                  example: Secret123
              required:
              - user_name
              - password
      responses:
        '200':
          description: 200 | OK. A JSON object containing the access token and additional information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_authentication_response'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
  /auth/refresh:
    post:
      tags:
      - Authentication
      summary: Gets a refreshed access token for shipper user.
      security: []
      description: This method allows users to refresh their access token based upon the original authentication event.
      requestBody:
        description: Request of the authentication renewal attempt.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                refresh_token:
                  description: The refresh token from the original authentication request.
                  type: string
                  example: asdfklwj43asdfja432sjdafjadkkj2345efsdk4ts
              required:
              - refresh_token
      responses:
        '200':
          description: 200 | OK. A new access token has been generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_authenticationrefresh_response'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_refreshtoken_response'
        '403':
          $ref: '#/components/responses/403'
  /network_partners:
    description: This endpoint allows a shipper organization to interact with it's network partners (capacity providers) that
      are defined in the Emerge Platform.
    get:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Network Partners
      summary: Gets all active network partners associated with the shipper organization.
      security:
      - BearerAuth: []
      description: This method gives the ability to a shipper organization to view its active network partners in the Emerge
        system.
      responses:
        '200':
          description: 200 | OK. Returns the list of associated active network partners.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getnetworkpartner_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
    post:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Network Partners
      summary: Invites a network partner to Emerge platform.
      security:
      - BearerAuth: []
      description: This method gives the ability to the shipper organization to invite it's network partner to the Emerge
        platform.
      requestBody:
        description: Request model to invite a network partner.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  required:
                  - first_name
                  - last_name
                  - email
                  - phone
                  properties:
                    first_name:
                      description: First name of the network partner contact.
                      type: string
                      example: mycarrier
                    last_name:
                      description: Last name of the network partner contact.
                      type: string
                      example: test
                    email:
                      description: Email id of the network partner contact.
                      type: string
                      format: email
                      example: mycarrier.test@abc.com
                    phone:
                      description: Phone number of the network partner contact.
                      $ref: '#/components/schemas/phone_request_object'
                partner_code:
                  description: Network partner's partner code. Supports upto 10 characters with only uppercase and numeric
                    values allowed.
                  type: string
                  example: AS1234
      responses:
        '200':
          description: 200 | Success. Network partner invited successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_invitenetworkpartner_response'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_networkpartner_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /network_partners/{partner_id}:
    delete:
      tags:
      - Network Partners
      summary: Deletes a network partner from Emerge platform.
      description: This method gives the ability to a shipper organization to delete it's network partner from the Emerge
        platform.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: partner_id
        schema:
          type: integer
          minimum: 1
          example: 1120
        required: true
        description: ID of the network partner.
      responses:
        '200':
          description: 200 | OK. Network partner deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /opportunities:
    parameters:
    - name: organization-id
      in: header
      description: The Organization GUID for the request. This Emerge provided value is only required if your integration
        user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
        of the header will be used.
      example:
      - 070C895C-AE61-4629-A603-829FC54CD816
      required: false
      schema:
        type: string
    post:
      tags:
      - Opportunities
      summary: Creates an opportunity.
      security:
      - BearerAuth: []
      description: Creates an opportunity, also called a quote, in the system. Emerge recommends that the call provides a
        pickup date to ensure that this opportunity can be posted to the marketplace.
      requestBody:
        description: Structure of the call to create an opportunity
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_opportunity_request_object'
      responses:
        '200':
          description: 200 | Success. A new opportunity has been created and an opportunity object is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_createopportunity_response'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
    get:
      tags:
      - Opportunities
      summary: Retrieves the details of opportunities by Reference Numbers
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: query
        name: references.customer
        schema:
          type: string
          example: CustRef123
        description: 'Reference Number of the opportunity <br />

          Keys: <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235);
          font-size:12px; font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere">
          references.customer </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.trailer
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.pro
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.pickupconfirmation
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.pickup
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.bol
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.appointment
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.delivery
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.other
          </span>

          <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
          font-family:''Source Code Pro'', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> references.po
          </span>

          '
      responses:
        '200':
          description: 200 | OK. Returns the matching opportunities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getopportunities_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /opportunities/{opportunity_id}:
    get:
      tags:
      - Opportunities
      summary: Retrieves the details of an opportunity by ID
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the opportunity
      responses:
        '200':
          description: 200 | OK. Returns the current opportunity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getopportunity_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
    delete:
      tags:
      - Opportunities
      summary: Deletes an opportunity by opportunity ID.
      description: Deletes an opportunity using the opportunity ID.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the opportunity
      responses:
        '200':
          description: 200 | OK. Opportunity deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
    put:
      tags:
      - Opportunities
      summary: Updates an opportunity by ID.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the opportunity
      requestBody:
        description: Structure of the call to create an opportunity
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_opportunity_request_object'
      responses:
        '200':
          description: 200 | OK. Returns the current opportunity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_updateopportunity_response'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /opportunities/{opportunity_id}/post_to_marketplace:
    post:
      tags:
      - Opportunities
      summary: Posts an opportunity to the Emerge marketplace.
      description: This method gives the ability to a shipper organization to post an opportunity to the Emerge marketplace.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the opportunity
      responses:
        '200':
          description: 200 | OK. Successfully posted to the Emerge marketplace.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        example: 0
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_opportunitypost_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /opportunities/{opportunity_id}/unpost_from_marketplace:
    post:
      tags:
      - Opportunities
      summary: Unposts an opportunity from the Emerge marketplace.
      description: This method gives the ability to a shipper organization to unpost an opportunity from the Emerge marketplace.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the opportunity
      responses:
        '200':
          description: 200 | OK. Successfully unposted from the Emerge marketplace
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        example: 0
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /opportunities/{opportunity_id}/options:
    description: Retrieves all the network partner options and market place options.
    get:
      tags:
      - Options
      summary: Gets options for an opportunity.
      security:
      - BearerAuth: []
      description: Gets all network partner options and market place options for a specific opportunity.
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 23892343
        required: true
        description: Id of the opportunity
      responses:
        '200':
          description: 200 | OK. Returns the all network partners and marketplace options for a corresponding opportunity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_Alloptions_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /opportunities/{opportunity_id}/post_to_network_partners:
    description: This method gives the ability to a shipper organization to post an opportunity to its network partners (capacity
      providers).
    post:
      tags:
      - Opportunities
      summary: Posts an opportunity to shipper's network partners.
      security:
      - BearerAuth: []
      description: This method gives the ability to a shipper organization to post an opportunity to its network partners
        (capacity providers).
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: opportunity_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: Id of the opportunity
      requestBody:
        description: Request model to post an opportunity to selected network partners.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                post_to_all:
                  type: boolean
                  description: Use this flag to control to whom the request needs to be posted. If set as true, system will
                    post request to all the network partners ignoring the other two fields. If set as false, it becomes mandatory
                    to input values in either partner_ids or partner_codes field. If the request payload is sent with input
                    in both partner_ids or partner_codes field, the system will merge both and post request to all the valid
                    partners_ids and partner_codes.
                partner_codes:
                  description: The list of codes of the selected network partners to whom the opportunity should be posted.
                  type: array
                  items:
                    description: The network partner code.
                    type: string
                  example:
                  - AS1234,X9898
                partner_ids:
                  description: The list of IDs of the selected network partners to whom the opportunity should be posted.
                  type: array
                  items:
                    description: The network partner ID.
                    type: string
                  example:
                  - 1111
                  - 9088
                  - 3456
      responses:
        '200':
          description: 200 | OK. Details of the network partners to whom the request could not be sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    $ref: '#/components/schemas/200_sendrequest_partners_response'
                  error:
                    type: object
                    properties:
                      code:
                        description: HTTP code
                        type: integer
                        example: 0
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_opportunity_notification_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /opportunities/by_customer_reference/{customer_reference_number}:
    delete:
      tags:
      - Opportunities
      summary: Deletes an opportunity by customer reference number.
      description: Delete an opportunity using the Customer Reference Number. If there are multiple matches for the Customer
        Reference number, all open opportunities with that Customer Reference number will be deleted.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: customer_reference_number
        schema:
          type: string
        required: true
        description: Customer reference number.
      responses:
        '200':
          description: 200 | OK. Opportunities deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /awards:
    description: The award endpoints allow a shipper to award a carrier in the Emerge system a load. Note that awards are
      not replacements for tenders. The awards endpoints are typically used when the Emerge system is used to source capacity,
      while the shipper's TMS is used to tender to the carrier.
    summary: Returns an array of awards.
    get:
      tags:
      - Awards
      summary: Returns an array of awards.
      security:
      - BearerAuth: []
      description: Returns a list of awards for a particular account. An opportunity can have either an award or a shipment.
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: query
        name: opportunity_id
        schema:
          type: integer
        description: Emerge system identifier for the awarded opportunity.
        example: 344392
      - in: query
        name: option_id
        schema:
          type: integer
        description: Emerge system identifier for the option associated with the awarded opportunity.
        example: 12545
      - in: query
        name: customer_reference_number
        schema:
          type: string
        description: Customer's identifier to match the awarded opportunity on.
        example: 1212934
      - in: query
        name: start_date
        schema:
          type: string
        description: Start of the date range within which the Awards should be searched. Supports yyyy-mm-dd format.
        example: '2021-10-28'
      - in: query
        name: end_date
        schema:
          type: string
        description: End of the date range within which the Awards should be searched. Supports yyyy-mm-dd format.
        example: '2021-10-30'
      responses:
        '200':
          description: 200 | OK. A JSON array of awards
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      type: object
                      properties:
                        award_id:
                          description: The id of the award.
                          type: integer
                          example: 238842
                        opportunity_id:
                          description: The id of the awarded opportunity.
                          type: integer
                          example: 238842
                        partner_quote_reference:
                          description: The quote reference number of the winning partner.
                          type: string
                          example: T12334
                        expiration_date:
                          description: The expiration date of the winning option.
                          type: string
                          example: '2021-10-28T07:53:59.402'
                        availability_date:
                          description: The availability date of the winning option.
                          type: string
                          example: '2021-10-28T07:53:59.402'
                        option_id:
                          description: The id of the winning option.
                          type: integer
                          example: 123
                        rate:
                          description: Rate of the winning option.
                          type: number
                          example: 300
                        is_total_rate:
                          description: Indicates whether the rate contains fuel surcharge or not.
                          type: boolean
                        modified_date:
                          description: Modified date of the winning option.
                          type: string
                          example: '2021-10-28T07:53:59.402'
                        created_date:
                          description: Created date of the winning option.
                          type: string
                          example: '2021-10-28T07:53:59.402'
                        partner:
                          $ref: '#/components/schemas/200_getawards_partner_response'
                        notes:
                          description: Notes on the award.
                          type: string
                          example: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
                        emerge_opportunity_reference:
                          description: Emerge reference for the awarded opportunity.
                          type: string
                          example: Q11238842
                        references:
                          $ref: '#/components/schemas/references_object'
                        award_method:
                          description: Award method for the awarded opportunity.
                          type: string
                          enum:
                          - Manual
                          - AutoAward
                          - BookItNow
                          example: Manual
                  error:
                    type: object
                    properties:
                      code:
                        description: HTTP code
                        type: integer
                        example: 0
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
    post:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Awards
      summary: Creates an award.
      security:
      - BearerAuth: []
      description: Creates an award. Awarding is the process of informing the carrier that they have won the shipment without
        tendering to them.
      requestBody:
        description: Request body of award
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                option_id:
                  description: The winning option id.
                  type: integer
                  example: 3233
                not_awarding_to_lowest_option_reason_code:
                  description: Reason code for not awarding to the lowest option, if applicable.
                  type: string
                  enum:
                  - ContractedLane
                  - ServiceLevel
                  - Accountability
                  - NoLongerAvailable
                  - Other
                  - NotProvided
                  example: ContractedLane
                not_awarding_to_lowest_option_reason:
                  description: Custom reason text for not awarding to the lowest option, when selected Reason Code is "Other".
                  type: string
                  example: The lowest option carrier is black listed in my organization.
              required:
              - option_id
      responses:
        '200':
          description: 200 | OK. A JSON award
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    properties:
                      award_id:
                        description: The id of the award.
                        type: integer
                        example: 238842
                      opportunity_id:
                        description: The id of the awarded opportunity.
                        type: integer
                        example: 238842
                      partner_quote_reference:
                        description: The quote reference number of the winning partner.
                        type: string
                        example: test123
                      expiration_date:
                        description: The expiration date of the winning option.
                        type: string
                        example: '2020-10-28T07:53:59.402Z'
                      availability_date:
                        description: The availability date of the winning option.
                        type: string
                        example: '2020-10-28T07:53:59.402'
                      option_id:
                        description: The id of the winning option.
                        type: integer
                        example: 123
                      rate:
                        description: Rate of the winning option.
                        type: number
                        example: 300
                      is_total_rate:
                        description: Indicates whether the rate contains fuel surcharge or not.
                        type: boolean
                      modified_date:
                        description: Modified date of the winning option.
                        type: string
                        example: '2020-10-28T07:53:59.402Z'
                      created_date:
                        description: Created date of the winning option.
                        type: string
                        example: '2020-10-28T07:53:59.402Z'
                      partner:
                        $ref: '#/components/schemas/200_getawards_partner_response'
                      notes:
                        description: Notes on the award.
                        type: string
                        example: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
                      emerge_opportunity_reference:
                        description: Emerge reference for the awarded opportunity.
                        type: string
                        example: Q11238842
                      references:
                        $ref: '#/components/schemas/references_object'
                      award_method:
                        description: Award method for the awarded opportunity.
                        type: string
                        enum:
                        - Manual
                        - AutoAward
                        - BookItNow
                        example: Manual
                  error:
                    type: object
                    properties:
                      code:
                        description: HTTP code
                        type: integer
                        example: 0
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_createaward_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /awards/{id}:
    description: The award endpoints allow a shipper to award a carrier in the Emerge system a load. Note that awards are
      not replacements for tenders. The awards endpoints are typically used when the Emerge system is used to source capacity,
      while the shipper's TMS is used to tender to the carrier.
    summary: Returns an award for award identifier.
    get:
      tags:
      - Awards
      summary: Retrieves the details of an award.
      security:
      - BearerAuth: []
      description: Returns an award. An opportunity can have either an award or a shipment.
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: Id of the award
      responses:
        '200':
          description: 200 | OK. A JSON award
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    properties:
                      award_id:
                        description: The id of the award.
                        type: integer
                        example: 238842
                      opportunity_id:
                        description: The id of the awarded opportunity.
                        type: integer
                        example: 238842
                      partner_quote_reference:
                        description: The quote reference number of the winning partner.
                        type: string
                        example: T12334
                      expiration_date:
                        description: The expiration date of the winning option.
                        type: string
                        example: '2021-10-28T07:53:59.402Z'
                      availability_date:
                        description: The availability date of the winning option.
                        type: string
                        example: '2021-10-28T07:53:59.402'
                      option_id:
                        description: The id of the winning option.
                        type: integer
                        example: 123
                      rate:
                        description: Rate of the winning option.
                        type: number
                        example: 300
                      is_total_rate:
                        description: Indicates whether the rate contains fuel surcharge or not.
                        type: boolean
                      modified_date:
                        description: Modified date of the winning option.
                        type: string
                        example: '2021-10-28T07:53:59.402Z'
                      created_date:
                        description: Created date of the winning option.
                        type: string
                        example: '2021-10-28T07:53:59.402Z'
                      partner:
                        $ref: '#/components/schemas/200_getawards_partner_response'
                      notes:
                        description: Notes on the award.
                        type: string
                        example: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
                      emerge_opportunity_reference:
                        description: Emerge reference for the awarded opportunity.
                        type: string
                        example: Q11238842
                      references:
                        $ref: '#/components/schemas/references_object'
                      award_method:
                        description: Award method for the awarded opportunity.
                        type: string
                        enum:
                        - Manual
                        - AutoAward
                        - BookItNow
                        example: Manual
                  error:
                    type: object
                    properties:
                      code:
                        description: HTTP code
                        type: integer
                        example: 0
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /tenders:
    summary: Creates a tender
    description: Tenders allow the shipper to award the shipment to Emerge Transportation. The Marketplace workflow does allow
      Emerge to reject a tender. At this time, however, a rejected tender will be performed manually to ensure the best customer
      experience and to simplify the integration experience.
    post:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Tenders
      description: The opportunity_id must be included in the create tender call.
      summary: Creates a tender
      security:
      - BearerAuth: []
      requestBody:
        description: Structure of the call to create the tender
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenders'
      responses:
        '200':
          description: 200 | Success. A new tender has been created and an tender object is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_createtender_response'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_createtender_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /tenders/{tender_id}:
    get:
      tags:
      - Tenders
      summary: Retrieves the details of a tender.
      description: Tenders allow the shipper to award the shipment to Emerge Transportation. The get tender endpoint allows
        a developer to retrieve a specific tender.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: tender_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the tender
      responses:
        '200':
          description: 200 | OK. Returns the current tender.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_createtender_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
    put:
      tags:
      - Tenders
      summary: Updates a tender.
      description: The shipment_id and rate value must be included in the update tender call.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: tender_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the tender
      requestBody:
        description: Structure of the call to create the tender
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenders'
      responses:
        '200':
          description: 200 | OK. The tender has been updated and tender object is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_createtender_response'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_updatetender_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /tenders/{tender_id}/cancel:
    post:
      tags:
      - Tenders
      summary: Cancel a tender.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: tender_id
        schema:
          type: integer
          minimum: 1
          example: 112020
        required: true
        description: ID of the tender
      responses:
        '200':
          description: 200 | OK. The tender has been canceled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '409':
          $ref: '#/components/responses/409'
  /shipments/{shipment_id}:
    get:
      tags:
      - Shipments
      summary: Get shipment.
      description: The Get Shipment end point allows shippers to get the full details of a shipment by it's ID.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: shipment_id
        schema:
          type: integer
          minimum: 1
          example: 12345
        required: true
        description: ID of the shipment
      responses:
        '200':
          description: 200 | OK. Returns shipment details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getshipment_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
  /webhooks:
    description: Webhooks are used to provide updates to the TMS when award or option events are generated within the Emerge
      system.
    post:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Webhooks
      summary: Create a new webhook.
      security:
      - BearerAuth: []
      requestBody:
        description: Structure of the call to create the webhooks
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhooks'
      responses:
        '201':
          description: 201 | Success. A new webhook has been created and a webhook object is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_createwebhook_response'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_webhook_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
    get:
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      tags:
      - Webhooks
      summary: Get a list of all webhooks.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: 200 | OK. List of webhooks for the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getwebhooks_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
  /webhooks/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Get the details of a webhook by Id.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: webhook_id
        schema:
          type: string
          example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
        required: true
        description: Identifier of the webhook
      responses:
        '200':
          description: 200 | OK. Webhook details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_getwebhook_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
    put:
      tags:
      - Webhooks
      summary: Update an existing webhook.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: webhook_id
        schema:
          type: string
          example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
        required: true
        description: Identifier of the webhook
      requestBody:
        description: Structure of the call to update the webhook
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatewebhook'
      responses:
        '200':
          description: 200 | OK. The webhook has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '400':
          description: 400 | Bad Request. A bad request was made. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_badrequest_webhook_response'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook.
      security:
      - BearerAuth: []
      parameters:
      - name: organization-id
        in: header
        description: The Organization GUID for the request. This Emerge provided value is only required if your integration
          user is in multiple organizations. Note that if multiple headers are passed, the organization from the first instance
          of the header will be used.
        example:
        - 070C895C-AE61-4629-A603-829FC54CD816
        required: false
        schema:
          type: string
      - in: path
        name: webhook_id
        schema:
          type: string
          example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
        required: true
        description: Identifier of the webhook
      responses:
        '200':
          description: 200 | OK. The webhook has been deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorcode_zero_without_message_object'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
components:
  schemas:
    200_authentication_response:
      type: object
      properties:
        response:
          type: object
          properties:
            token:
              description: The access token to be used in subsequent requests.
              type: string
              example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik9UYzROVFExTTBSRVF6SXhOamd6UVRZNU0wSkNRak5HTWpVNE5VTkVNa1l4TVROQk9VSkROQSJ9.eyJodHRwczovL2F1dGgwLmVtZXJnZXRtcy5jb20vVXNlcklkIjoiY2ViN2Q0ZWYtOTA1YS00MTlkLWFjMWUtZmQ0Y2IwMzc4MjEyIiwiaHR0cHM6Ly9hdXRoMC5lbWVyZ2V0bXMuY29tL09yZ2FuaXphdGlvbklkIjoiZWU3YmRjMGItOTFiMy00NDAwLWFmZjUtYzc3ZGZlMjk3NjA2IiwiaHR0cHM6Ly9hdXRoMC5lbWVyZ2V0bXMuY29tL1NoaXBtZW50UHJvdmlkZXJPcmdhbml6YXRpb25JZCI6ImVlN2JkYzBiLTkxYjMtNDQwMC1hZmY1LWM3N2RmZTI5NzYwNiIsImlzcyI6Imh0dHBzOi8vZW1lcmdlLXNzby10ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZGQ2OGNjYjRmOGZmNzAzYjI5NmQ5Y2MiLCJhdWQiOlsiaHR0cHM6Ly9hcHAuZW1lcmdldG1zLmNvbSIsImh0dHBzOi8vZW1lcmdlLXNzby10ZXN0LmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE1OTk3NzMzNTIsImV4cCI6MTU5OTg1OTc1MiwiYXpwIjoiSWpSRERQajFNeVV5SEg2TEF1aTFqY1loM3NuV0EweDYiLCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIGFkZHJlc3MgcGhvbmUgYXRvbSByZnA6ZnAgcmZwOmNwIG9mZmxpbmVfYWNjZXNzIiwiZ3R5IjoicGFzc3dvcmQifQ.FamVUCPS7Q2B1u7zUPC5Guk2HKTQ6Km6i6CX_Tpg1h98gnuvnWrC9FF-awgldjHmCNoeqI9ImjEVpecP00oAtHWiDaXMTd7UsyPcHAWh2xatZ8LPCrnw-0ox3egSSv5KxCTrnXAhTxwR4XI07-jxWjTgkw5dSVGc70Q9a_PC8nXe7-1SDKmLpMKFmtU60eH52kmUy0CECi_GfYS7xKskZYgX3Xhx-C1jCWFbCbmRA1Yxvir450miOIo0g5AxaJjbTgm6ao2OGuPzyLUTrXaSchK1J9xrv8dXhKh-PSv0eIG5d2MVHJf4O_KsFckt40OuiiEokrdsfdsfdfhgsdOuDkQ
            expires_in:
              description: Expiration time of token in seconds.
              type: number
              example: 86400
            refresh_token:
              description: The token required to call refresh_token endpoint to get a new access token.
              type: string
              example: ciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik9UYzROVFExTTBSRVF6SXhOamd6UVRZ
        error:
          type: object
          properties:
            code:
              type: integer
              example: 0
    200_authenticationrefresh_response:
      type: object
      properties:
        response:
          type: object
          properties:
            token:
              description: The access token to be used in subsequent requests.
              type: string
              example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik9UYzROVFExTTBSRVF6SXhOamd6UVRZNU0wSkNRak5HTWpVNE5VTkVNa1l4TVROQk9VSkROQSJ9.eyJodHRwczovL2F1dGgwLmVtZXJnZXRtcy5jb20vVXNlcklkIjoiY2ViN2Q0ZWYtOTA1YS00MTlkLWFjMWUtZmQ0Y2IwMzc4MjEyIiwiaHR0cHM6Ly9hdXRoMC5lbWVyZ2V0bXMuY29tL09yZ2FuaXphdGlvbklkIjoiZWU3YmRjMGItOTFiMy00NDAwLWFmZjUtYzc3ZGZlMjk3NjA2IiwiaHR0cHM6Ly9hdXRoMC5lbWVyZ2V0bXMuY29tL1NoaXBtZW50UHJvdmlkZXJPcmdhbml6YXRpb25JZCI6ImVlN2JkYzBiLTkxYjMtNDQwMC1hZmY1LWM3N2RmZTI5NzYwNiIsImlzcyI6Imh0dHBzOi8vZW1lcmdlLXNzby10ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZGQ2OGNjYjRmOGZmNzAzYjI5NmQ5Y2MiLCJhdWQiOlsiaHR0cHM6Ly9hcHAuZW1lcmdldG1zLmNvbSIsImh0dHBzOi8vZW1lcmdlLXNzby10ZXN0LmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE1OTk3NzMzNTIsImV4cCI6MTU5OTg1OTc1MiwiYXpwIjoiSWpSRERQajFNeVV5SEg2TEF1aTFqY1loM3NuV0EweDYiLCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIGFkZHJlc3MgcGhvbmUgYXRvbSByZnA6ZnAgcmZwOmNwIG9mZmxpbmVfYWNjZXNzIiwiZ3R5IjoicGFzc3dvcmQifQ.FamVUCPS7Q2B1u7zUPC5Guk2HKTQ6Km6i6CX_Tpg1h98gnuvnWrC9FF-awgldjHmCNoeqI9ImjEVpecP00oAtHWiDaXMTd7UsyPcHAWh2xatZ8LPCrnw-0ox3egSSv5KxCTrnXAhTxwR4XI07-jxWjTgkw5dSVGc70Q9a_PC8nXe7-1SDKmLpMKFmtU60eH52kmUy0CECi_GfYS7xKskZYgX3Xhx-C1jCWFbCbmRA1Yxvir450miOIo0g5AxaJjbTgm6ao2OGuPzyLUTrXaSchK1J9xrv8dXhKh-PSv0eIG5d2MVHJf4O_KsFckt40OuiiEokrdsfdsfdfhgsdOuDkQ
            expires_in:
              description: Expiration time of token in seconds.
              type: number
              example: 86400
        error:
          type: object
          properties:
            code:
              type: integer
              example: 0
    200_getopportunity_response:
      description: 200 | OK. Opportunity successfully retrieved
      type: object
      properties:
        response:
          type: object
          properties:
            id:
              description: The opportunity ID
              type: integer
              example: 112020
            organization_id:
              description: The ID of the organization
              type: integer
              example: 6338
            length_of_haul:
              description: The calculated length of haul of the opportunity. Calculated in miles.
              type: integer
              example: 1084
            length_of_haul_source_id:
              description: The source of the length of haul calculation. Enumeration.
              type: integer
              example: 2
            is_length_of_haul_override_enabled:
              description: Boolean to indicate if the length of haul has been overridden.
              type: boolean
              example: false
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            reefer_maximum_temperature:
              description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 20
            reefer_minimum_temperature:
              description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 1
            cargo_value:
              description: The cargo value for this opportunity.
              type: number
              example: 100000
            stops:
              $ref: '#/components/schemas/opportunity_response_stops_object'
            notes:
              $ref: '#/components/schemas/notes_object'
            commodities:
              $ref: '#/components/schemas/commodities_object'
            assigned_user_id:
              description: The user who is assigned to the opportunity.
              type: integer
              example: 1206858
            references:
              $ref: '#/components/schemas/references_object'
            created_date:
              description: The date the opportunity was created.
              type: string
              example: '2021-09-15T00:48:15.2148104+00:00'
            modified_date:
              description: The date the opportunity was modified.
              type: string
              example: '2021-09-15T00:48:15.2148104+00:00'
            reference:
              type: string
              example: Q11112020
            load_type_id:
              $ref: '#/components/schemas/load_type_id_object'
            freight_provider_organization_equipment_type_id:
              type: integer
              example: 8679
            equipment_size:
              $ref: '#/components/schemas/equipment_size_object'
            status_id:
              $ref: '#/components/schemas/opportunity_status'
            is_tracking_required:
              type: boolean
              example: false
            is_hot_load:
              type: boolean
              example: false
            type_id:
              $ref: '#/components/schemas/opportunity_type'
            is_priced_at:
              type: boolean
              example: false
            is_deleted:
              type: boolean
              example: false
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            tags:
              $ref: '#/components/schemas/tags_object'
            ui_url:
              type: string
              description: The url for navigating to details page of an opportunity in emerge UI.
              example: https://app.emergemarket.io/en/quote/3243242
            option_count:
              description: The number of options currently in the marketplace.
              type: integer
              example: 0
            rate_type:
              description: The rate type of an opportunity.
              type: string
              enum:
              - ALL_IN: 1
              - LH_ONLY: 2
              example: 1
            freight_provider_organization_equipment_type_name:
              type: string
              example: Reefer
            book_it_now:
              $ref: '#/components/schemas/response_book_it_now_object'
            bid_duration_end_time:
              description: The Date and Time the Bid Duration will End in UTC. Supports yyyy-mm-ddThh:mm:ss format.
              type: string
              example: '2021-10-06T10:30:20.3099236+00:00'
            quote_watchers:
              description: Identify additional users within your organization to provide quote notifications.
              type: array
              items:
                description: Email.
                type: string
              example:
              - shipper@stonelogistics.com
              - emergetest@emergetms.com
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    200_getopportunities_response:
      description: 200 | OK. Opportunities successfully retrieved
      type: object
      properties:
        response:
          type: array
          items:
            type: object
            properties:
              id:
                description: The opportunity ID
                type: integer
                example: 112020
              organization_id:
                description: The ID of the organization
                type: integer
                example: 6338
              length_of_haul:
                description: The calculated length of haul of the opportunity. Calculated in miles.
                type: integer
                example: 1084
              length_of_haul_source_id:
                description: The source of the length of haul calculation. Enumeration.
                type: integer
                example: 2
              is_length_of_haul_override_enabled:
                description: Boolean to indicate if the length of haul has been overridden.
                type: boolean
                example: false
              equipment_type_id:
                $ref: '#/components/schemas/equipment_type_id_object'
              reefer_maximum_temperature:
                description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
                type: integer
                example: 20
              reefer_minimum_temperature:
                description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
                type: integer
                example: 1
              cargo_value:
                description: The cargo value for this opportunity.
                type: number
                example: 100000
              stops:
                $ref: '#/components/schemas/opportunity_response_stops_object'
              notes:
                $ref: '#/components/schemas/notes_object'
              commodities:
                $ref: '#/components/schemas/commodities_object'
              assigned_user_id:
                description: The user who is assigned to the opportunity.
                type: integer
                example: 1206858
              references:
                $ref: '#/components/schemas/references_object'
              created_date:
                description: The date the opportunity was created.
                type: string
                example: '2021-09-15T00:48:15.2148104+00:00'
              modified_date:
                description: The date the opportunity was modified.
                type: string
                example: '2021-09-15T00:48:15.2148104+00:00'
              reference:
                type: string
                example: Q11112020
              load_type_id:
                $ref: '#/components/schemas/load_type_id_object'
              freight_provider_organization_equipment_type_id:
                type: integer
                example: 8679
              equipment_size:
                $ref: '#/components/schemas/equipment_size_object'
              status_id:
                $ref: '#/components/schemas/opportunity_status'
              is_tracking_required:
                type: boolean
                example: false
              is_hot_load:
                type: boolean
                example: false
              type_id:
                $ref: '#/components/schemas/opportunity_type'
              is_priced_at:
                type: boolean
                example: false
              is_deleted:
                type: boolean
                example: false
              accessorials:
                $ref: '#/components/schemas/accessorials_object'
              tags:
                $ref: '#/components/schemas/tags_object'
              ui_url:
                type: string
                description: The url for navigating to details page of an opportunity in emerge UI.
                example: https://app.emergemarket.io/en/quote/3243242
              option_count:
                description: The number of options currently in the marketplace.
                type: integer
                example: 0
              rate_type:
                description: The rate type of an opportunity.
                type: string
                enum:
                - ALL_IN: 1
                - LH_ONLY: 2
                example: 1
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    200_options_response:
      type: object
      properties:
        response:
          type: object
          properties:
            count_of_active_options:
              description: A numerical count of the active options associated with the opportunity.
              type: integer
              example: 1
            current_option:
              description: The lowest priced option.
              type: object
              properties:
                availability_date:
                  type: string
                  example: '2021-09-21T16:17:31.8333705+00:00'
                created_date:
                  type: string
                  example: '2021-09-21T16:17:31.8333705+00:00'
                modified_date:
                  type: string
                  example: '2021-09-21T16:17:49.5156372+00:00'
                opportunity_id:
                  type: integer
                  example: 16769
                id:
                  type: integer
                  description: The ID of the option.
                  example: 15633
                rate:
                  description: The rate offered to the shipper in USD
                  type: number
                  example: 3329.64
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    200_Alloptions_response:
      type: object
      properties:
        response:
          type: array
          items:
            type: object
            properties:
              opportunity_id:
                description: The id of the opportunity.
                type: integer
                example: 238842
              option_id:
                description: The id of the option.
                type: integer
                example: 123
              partner_quote_reference:
                description: The quote reference number of the option.
                type: string
                example: T12334
              expiration_date:
                description: The expiration date of the option.
                type: string
                example: '2021-10-28T07:53:59.402Z'
              availability_date:
                description: The availability date of the option.
                type: string
                example: '2021-10-28T07:53:59.402'
              rate:
                description: Rate of the option.
                type: number
                example: 300
              is_total_rate:
                description: true if linehaul and fuel rate included as part of total rate else false.
                type: boolean
                example: true
              modified_date:
                description: Modified date of the option.
                type: string
                example: '2020-10-28T07:53:59.402Z'
              created_date:
                description: Created date of the option.
                type: string
                example: '2020-10-28T07:53:59.402Z'
              partner:
                $ref: '#/components/schemas/200_getoption_partner_response'
              notes:
                description: option notes.
                type: string
                example: Test notes
              references:
                $ref: '#/components/schemas/references_object'
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    200_getnetworkpartner_response:
      description: 200 | OK. Network partners successfully retrieved.
      type: object
      properties:
        response:
          type: array
          items:
            type: object
            properties:
              partner_id:
                description: The network partner identifier.
                type: integer
                example: 123
              partner_code:
                description: Network partner's partner code.
                type: string
                example: AS1234
              type:
                description: Network partner's type.
                type: string
                enum:
                - Network
                - Default
              status:
                description: Network partner's status.
                type: string
                enum:
                - AwaitingConfirmation
                - Confirmed
              created_date:
                description: Created date of the partner.
                type: string
                example: '2021-10-28T07:53:59.402Z'
              transportation_entity:
                type: object
                properties:
                  company_name:
                    description: Transportation entity company name.
                    type: string
                    example: My Carrier Logistic
                  legal_name:
                    description: Transportation entity legal name.
                    type: string
                    example: My Carrier Logistic
                  dot_number:
                    description: Transportation entity DOT number.
                    type: integer
                    example: 2894801
                  docket_number:
                    description: Transportation entity Docket number.
                    type: string
                    example: MC143583
                  address:
                    description: Transportation entity address.
                    type: object
                    properties:
                      address:
                        type: string
                        example: 3665 North Harbor Drive
                      city:
                        type: string
                        example: San Diego
                      state:
                        type: string
                        example: CA
                      postal_code:
                        type: string
                        example: '92101'
              contact:
                type: object
                properties:
                  first_name:
                    description: Network partner's first name.
                    type: string
                    example: mycarrier
                  last_name:
                    description: Network partner's last name.
                    type: string
                    example: test
                  email:
                    description: Network partner contact's email id.
                    type: string
                    format: email
                    example: mycarrier.test@abc.com
                  phone:
                    description: Network partner contact's phone number.
                    $ref: '#/components/schemas/phone_response_object'
              tags:
                $ref: '#/components/schemas/tags_object'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    200_invitenetworkpartner_response:
      description: 200 | OK. Network partners successfully retrieved.
      type: object
      properties:
        response:
          type: object
          properties:
            partner_id:
              description: The network partner identifier.
              type: integer
              example: 123
            partner_code:
              description: Network partner's partner code.
              type: string
              example: AS1234
            type:
              description: Network partner's type.
              type: string
              enum:
              - Network
              - Default
            status:
              description: Network partner's status.
              type: string
              enum:
              - AwaitingConfirmation
              - Confirmed
            created_date:
              description: Created date of the partner.
              type: string
              example: '2021-10-28T07:53:59.402Z'
            contact:
              description: Note that this may have different details from what was provided by the shipper when inviting the
                network partner. This happens when the network partner already existed in Emerge platform with different details
                or modifies it's details during or after registeration.
              type: object
              properties:
                first_name:
                  description: Network partner's first name.
                  type: string
                  example: mycarrier
                last_name:
                  description: Network partner's last name.
                  type: string
                  example: test
                email:
                  description: Network partner contact's email id.
                  type: string
                  format: email
                  example: mycarrier.test@abc.com
                phone:
                  description: Network partner contact's phone number.
                  $ref: '#/components/schemas/phone_response_object'
            transportation_entity:
              type: object
              properties:
                company_name:
                  description: Transportation entity company name.
                  type: string
                  example: My Carrier Logistic
                legal_name:
                  description: Transportation entity legal name.
                  type: string
                  example: My Carrier Logistic
                dot_number:
                  description: Transportation entity DOT number.
                  type: integer
                  example: 2894801
                docket_number:
                  description: Transportation entity Docket number.
                  type: string
                  example: MC143583
                address:
                  description: Transportation entity address.
                  type: object
                  properties:
                    address:
                      type: string
                      example: 3665 North Harbor Drive
                    city:
                      type: string
                      example: San Diego
                    state:
                      type: string
                      example: CA
                    postal_code:
                      type: string
                      example: '92101'
            tags:
              $ref: '#/components/schemas/tags_object'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    201_createopportunity_response:
      description: 201 | Success. Opportunity successfully created
      type: object
      properties:
        response:
          type: object
          properties:
            id:
              description: The opportunity ID. The opportunity ID is used in subsequent calls.
              type: integer
              example: 19737
            length_of_haul:
              description: The calculated length of haul of the opportunity. Calculated in miles.
              type: integer
              example: 1080
            is_length_of_haul_override_enabled:
              description: Boolean to indicate if the length of haul has been overridden.
              type: boolean
              example: false
            is_schedule_required:
              description: Boolean that specifies if a schedule is required.
              type: boolean
              deprecated: true
              example: false
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            reefer_maximum_temperature:
              description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 20
            reefer_minimum_temperature:
              description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 1
            cargo_value:
              description: The cargo value for this opportunity.
              type: number
              example: 100000
            assigned_user_id:
              description: The user who is assigned to the opportunity.
              type: integer
              example: 1206858
            invite_by_tag:
              description: Defines the network partner tags to whom the opportunity is posted. It will contain only the valid
                tags.
              type: array
              items:
                type: string
                example: firstTag
            stops:
              $ref: '#/components/schemas/opportunity_response_stops_object'
            notes:
              $ref: '#/components/schemas/notes_object'
            commodities:
              $ref: '#/components/schemas/commodities_object'
            references:
              $ref: '#/components/schemas/references_object'
            created_date:
              description: The date timestamp of the creation of the opportunity.
              type: string
              example: '2019-02-09T18:07:05.460965+00:00'
            reference:
              description: The quote number associated with the opportunity.
              type: string
              example: Q43434222
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            tags:
              $ref: '#/components/schemas/tags_object'
            ui_url:
              type: string
              description: The url for navigating to details page of an opportunity in emerge UI.
              example: https://app.emergemarket.io/en/quote/3243242
            rate_type:
              description: The rate type of an opportunity.
              type: string
              enum:
              - ALL_IN: 1
              - LH_ONLY: 2
              example: 1
            freight_provider_organization_equipment_type_id:
              type: integer
              example: 974
            freight_provider_organization_equipment_type_name:
              type: string
              example: Reefer
            bid_duration_end_time:
              description: The Date and Time the Bid Duration will End in UTC. Supports yyyy-mm-ddThh:mm:ss format.
              type: string
              example: '2021-10-06T10:30:20.3099236+00:00'
            quote_watchers:
              description: Identify additional users within your organization to provide quote notifications.
              type: array
              items:
                description: Email.
                type: string
              example:
              - shipper@stonelogistics.com
              - emergetest@emergetms.com
            shipment_id:
              description: The shipment ID associated with the opportunity. The shipment ID is used in subsequent calls.
              type: integer
              example: 54321
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    200_updateopportunity_response:
      description: 200 | OK. Opportunity successfully retrieved
      type: object
      properties:
        response:
          type: object
          properties:
            id:
              description: The opportunity ID
              type: integer
              example: 112020
            organization_id:
              description: The ID of the organization
              type: integer
              example: 6338
            length_of_haul:
              description: The calculated length of haul of the opportunity. Calculated in miles.
              type: integer
              example: 1084
            length_of_haul_source_id:
              description: The source of the length of haul calculation. Enumeration.
              type: integer
              example: 2
            is_length_of_haul_override_enabled:
              description: Boolean to indicate if the length of haul has been overridden.
              type: boolean
              example: false
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            reefer_maximum_temperature:
              description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 20
            reefer_minimum_temperature:
              description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 1
            cargo_value:
              description: The cargo value for this opportunity.
              type: number
              example: 100000
            stops:
              $ref: '#/components/schemas/opportunity_response_stops_object'
            notes:
              $ref: '#/components/schemas/notes_object'
            commodities:
              $ref: '#/components/schemas/commodities_object'
            assigned_user_id:
              description: The user who is assigned to the opportunity.
              type: integer
              example: 1206858
            references:
              $ref: '#/components/schemas/references_object'
            created_date:
              description: The date the opportunity was created.
              type: string
              example: '2021-09-15T00:48:15.2148104+00:00'
            modified_date:
              description: The date the opportunity was modified.
              type: string
              example: '2021-09-15T00:48:15.2148104+00:00'
            reference:
              type: string
              example: Q11112020
            load_type_id:
              $ref: '#/components/schemas/load_type_id_object'
            freight_provider_organization_equipment_type_id:
              type: integer
              example: 8679
            equipment_size:
              $ref: '#/components/schemas/equipment_size_object'
            status_id:
              $ref: '#/components/schemas/opportunity_status'
            is_tracking_required:
              type: boolean
              example: false
            is_hot_load:
              type: boolean
              example: false
            type_id:
              $ref: '#/components/schemas/opportunity_type'
            is_priced_at:
              type: boolean
              example: false
            is_deleted:
              type: boolean
              example: false
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            tags:
              $ref: '#/components/schemas/tags_object'
            ui_url:
              type: string
              description: The url for navigating to details page of an opportunity in emerge UI.
              example: https://app.emergemarket.io/en/quote/3243242
            option_count:
              description: The number of options currently in the marketplace.
              type: integer
              example: 0
            rate_type:
              description: The rate type of an opportunity.
              type: string
              enum:
              - ALL_IN: 1
              - LH_ONLY: 2
              example: 1
            freight_provider_organization_equipment_type_name:
              type: string
              example: Reefer
            bid_duration_end_time:
              description: The Date and Time the Bid Duration will End in UTC. Supports yyyy-mm-ddThh:mm:ss format.
              type: string
              example: '2021-10-06T10:30:20.3099236+00:00'
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    201_createtender_response:
      description: 201 | Success. Tender successfully created
      type: object
      properties:
        response:
          type: object
          properties:
            id:
              description: The tender ID. The tender ID is used in subsequent calls.
              type: integer
              example: 232343
            assigned_user_id:
              type: integer
              example: 1305583
            partner_id:
              type: integer
              example: 953
            shipment_id:
              type: integer
              example: 16679
            shipment_status_id:
              $ref: '#/components/schemas/shipment_status'
            load_type_id:
              $ref: '#/components/schemas/load_type_id_object'
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            reefer_maximum_temperature:
              description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 20
            reefer_minimum_temperature:
              description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
              type: integer
              example: 1
            freight_provider_organization_equipment_type_id:
              type: integer
              example: 974
            freight_provider_organization_equipment_type_name:
              type: string
              example: Reefer
            length_of_haul:
              type: integer
              example: 1084
            length_of_haul_source_id:
              description: The source of the length of haul calculation. Enumeration.
              type: integer
              example: 2
            is_length_of_haul_override_enabled:
              description: Boolean to indicate if the length of haul has been overridden.
              type: boolean
              example: false
            length_of_haul_result:
              $ref: '#/components/schemas/length_of_haul_result_object'
            is_tracking_required:
              type: boolean
              example: false
            rate:
              description: The rate for the shipment in USD.
              type: integer
              example: 3866
            rate_per_mile:
              description: the rate for the shipment per mile in USD.
              type: number
              example: 3.57
            fuel_rate:
              description: The total rate for the fuel in USD.
              type: number
              example: 238.48
            is_hot_load:
              type: boolean
              example: false
            option_id:
              description: The ID of the option associated with the tender
              type: integer
              example: 15618
            option:
              description: The option details
              type: object
              properties:
                id:
                  description: The ID of the option associated with the tender
                  type: integer
                  example: 15618
                modified_date:
                  type: string
                  example: '2021-09-18T20:39:20.8137938+00:00'
                type_id:
                  type: integer
                  example: 5
                opportunity_id:
                  type: integer
                  example: 16734
                partner_id:
                  type: integer
                  example: 953
                rate:
                  type: integer
                  example: 3866
                rate_per_mile:
                  type: number
                  example: 3.57
                fuel_rate:
                  type: number
                  example: 238.48
                is_fuel_included:
                  type: boolean
                  example: false
                line_haul_rate:
                  type: number
                  example: 3627.52
                line_haul_rate_per_mile:
                  type: number
                  example: 3.35
                notes:
                  $ref: '#/components/schemas/notes_object'
            commodities:
              $ref: '#/components/schemas/commodities_object'
            stops:
              $ref: '#/components/schemas/opportunity_response_stops_object'
            references:
              $ref: '#/components/schemas/references_object'
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            notes:
              $ref: '#/components/schemas/notes_object'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    200_getshipment_response:
      description: 200 | Ok. Returns shipment details.
      type: object
      properties:
        response:
          type: object
          properties:
            id:
              type: integer
              example: 1305583
            opportunity:
              type: object
              properties:
                id:
                  description: The opportunity ID
                  type: integer
                  example: 112020
                organization_id:
                  description: The ID of the organization
                  type: integer
                  example: 6338
                length_of_haul:
                  description: The calculated length of haul of the opportunity. Calculated in miles.
                  type: integer
                  example: 1084
                length_of_haul_source_id:
                  description: The source of the length of haul calculation.
                  type: integer
                  example: 2
                is_length_of_haul_override_enabled:
                  description: Boolean to indicate if the length of haul has been overridden.
                  type: boolean
                  example: false
                stops:
                  $ref: '#/components/schemas/opportunity_response_stops_object'
                notes:
                  $ref: '#/components/schemas/notes_object'
                commodities:
                  $ref: '#/components/schemas/commodities_object'
                assigned_user_id:
                  description: The user who is assigned to the opportunity.
                  type: integer
                  example: 1206858
                references:
                  $ref: '#/components/schemas/references_object'
                created_date:
                  description: The date the opportunity was created.
                  type: string
                  example: '2020-09-15T00:48:15.2148104+00:00'
                modified_date:
                  description: The date the opportunity was modified.
                  type: string
                  example: '2020-09-15T00:48:15.2148104+00:00'
                reference:
                  type: string
                  example: Q11112020
                load_type_id:
                  $ref: '#/components/schemas/load_type_id_object'
                equipment_type_id:
                  $ref: '#/components/schemas/equipment_type_id_object'
                freight_provider_organization_equipment_type_id:
                  type: integer
                  example: 8679
                equipment_size:
                  $ref: '#/components/schemas/equipment_size_object'
                status_id:
                  $ref: '#/components/schemas/opportunity_status'
                is_tracking_required:
                  type: boolean
                  example: false
                is_hot_load:
                  type: boolean
                  example: false
                type_id:
                  $ref: '#/components/schemas/opportunity_type'
                is_priced_at:
                  type: boolean
                  example: false
                is_deleted:
                  type: boolean
                  example: false
                accessorials:
                  $ref: '#/components/schemas/accessorials_object'
                tags:
                  $ref: '#/components/schemas/tags_object'
                option_count:
                  description: The number of options currently in the marketplace.
                  type: integer
                  example: 0
            reference:
              type: string
              example: S11019753
            status_id:
              $ref: '#/components/schemas/shipment_status'
            current_tender:
              type: object
              properties:
                id:
                  description: The tender ID. The tender ID is used in subsequent calls.
                  type: integer
                  example: 232343
                assigned_user_id:
                  type: integer
                  example: 1305583
                partner_id:
                  type: integer
                  example: 953
                shipment_id:
                  type: integer
                  example: 16679
                shipment_status_id:
                  $ref: '#/components/schemas/shipment_status'
                load_type_id:
                  $ref: '#/components/schemas/load_type_id_object'
                equipment_type_id:
                  $ref: '#/components/schemas/equipment_type_id_object'
                freight_provider_organization_equipment_type_id:
                  type: integer
                  example: 974
                freight_provider_organization_equipment_type_name:
                  type: string
                  example: Reefer
                length_of_haul:
                  type: integer
                  example: 1084
                length_of_haul_source_id:
                  description: The source of the length of haul calculation. Enumeration.
                  type: integer
                  example: 2
                is_length_of_haul_override_enabled:
                  description: Boolean to indicate if the length of haul has been overridden.
                  type: boolean
                  example: false
                length_of_haul_result:
                  $ref: '#/components/schemas/length_of_haul_result_object'
                is_tracking_required:
                  type: boolean
                  example: false
                rate:
                  description: The rate for the shipment in USD.
                  type: integer
                  example: 3866
                rate_per_mile:
                  description: the rate for the shipment per mile in USD.
                  type: number
                  example: 3.57
                fuel_rate:
                  description: The total rate for the fuel in USD.
                  type: number
                  example: 238.48
                is_hot_load:
                  type: boolean
                  example: false
                reefer_maximum_temperature:
                  description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
                  type: integer
                  example: 20
                reefer_minimum_temperature:
                  description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
                  type: integer
                  example: 1
                option_id:
                  description: The ID of the option associated with the tender
                  type: integer
                  example: 15618
                option:
                  description: The option details
                  type: object
                  properties:
                    id:
                      description: The ID of the option associated with the tender
                      type: integer
                      example: 15618
                    modified_date:
                      type: string
                      example: '2020-09-18T20:39:20.8137938+00:00'
                    type_id:
                      type: integer
                      example: 5
                    opportunity_id:
                      type: integer
                      example: 16734
                    partner_id:
                      type: integer
                      example: 953
                    rate:
                      type: integer
                      example: 3866
                    rate_per_mile:
                      type: number
                      example: 3.57
                    fuel_rate:
                      type: number
                      example: 238.48
                    is_fuel_included:
                      type: boolean
                      example: false
                    line_haul_rate:
                      type: number
                      example: 3627.52
                    line_haul_rate_per_mile:
                      type: number
                      example: 3.35
                    notes:
                      $ref: '#/components/schemas/notes_object'
                commodities:
                  $ref: '#/components/schemas/commodities_object'
                stops:
                  $ref: '#/components/schemas/opportunity_response_stops_object'
                references:
                  $ref: '#/components/schemas/references_object'
                accessorials:
                  $ref: '#/components/schemas/accessorials_object'
                notes:
                  $ref: '#/components/schemas/notes_object'
            public_tracking_link:
              description: This feature is limited to ProcureOS Pro plans
              type: string
              example: https://app.emergemarket.io/en/publictracking/12345
    400_badrequest_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: load_type_id
                  value:
                    type: string
                    example: load_type_id has a range of values which does not include 12
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_webhook_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: url
                  value:
                    type: string
                    example: url must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_networkpartner_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: first_name
                  value:
                    type: string
                    example: first_name must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_opportunitybyid_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            messages:
              type: array
              items:
                type: string
                example: Quote not found.
    400_badrequest_opportunity_notification_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: partner_ids
                  value:
                    type: string
                    example: '''partner_ids'' or ''partner_codes'' must not be empty when post_to_all is false.'
    400_badrequest_opportunitypost_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: posting_to
                  value:
                    type: string
                    example: posting_to must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_createaward_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: option_id
                  value:
                    type: string
                    example: option_id must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_createtender_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: opportunity_id
                  value:
                    type: string
                    example: opportunity_id must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_updatetender_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: shipment_id
                  value:
                    type: string
                    example: shipment_id must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    400_badrequest_refreshtoken_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 400
            detailed_errors:
              description: Error messages
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: refresh_token
                  value:
                    type: string
                    example: refresh_token must not be empty.
            messages:
              type: array
              items:
                type: string
                example: Validation failed.
    403_forbidden_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 403
            messages:
              description: Error messages
              type: array
              items:
                type: string
                example: Response status code does not indicate success 403 (Forbidden)
    409_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              example: 409
            messages:
              type: array
              items:
                type: string
                example: The tender status is invalid.
    429_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              example: 429
            messages:
              type: array
              items:
                type: string
                example: Too many requests.
    500_response:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              example: 500
            messages:
              type: array
              items:
                type: string
                example: userName.
    create_opportunity_request_object:
      type: object
      required:
      - stops
      - commodities
      - load_type_id
      - equipment_type_id
      properties:
        load_type_id:
          $ref: '#/components/schemas/request_load_type_id_object'
        equipment_type_id:
          $ref: '#/components/schemas/request_equipment_type_id_object'
        reefer_maximum_temperature:
          description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 20
        reefer_minimum_temperature:
          description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 1
        equipment_size:
          $ref: '#/components/schemas/equipment_size_object'
        search_in_marketplace:
          description: Defines if the opportunity is upon creation submitted to the Emerge marketplace.
          type: boolean
          default: true
        request_all_network_partners:
          description: Defines if the opportunity is upon creation submitted to the network partners.
          type: boolean
          default: false
        is_hot_load:
          description: Identifies if the load is hot.
          type: boolean
          default: false
        is_tracking_required:
          description: Defines if tracking is required on this opportunity.
          type: boolean
          default: false
        cargo_value:
          description: The cargo value for this opportunity.
          type: number
          minimum: 1
          example: 100000
        assigned_user:
          description: Defines the user to whom the opportunity will be assigned. If not provided, it will be defaulted to
            the authenticated user.
          type: string
          format: email
          example: shipper@stonelogistics.com
        invite_by_tag:
          $ref: '#/components/schemas/invite_by_tag_object'
        stops:
          $ref: '#/components/schemas/opportunity_request_stops_object'
        commodities:
          $ref: '#/components/schemas/request_commodities_object'
        accessorials:
          $ref: '#/components/schemas/request_accessorials_object'
        references:
          $ref: '#/components/schemas/request_references_object'
        notes:
          description: Opportunity notes.
          type: array
          items:
            properties:
              note:
                description: The specific note for the opportunity
                type: string
        tags:
          $ref: '#/components/schemas/tags_object'
        mileage_override:
          description: Miles to be overridden.
          type: integer
          example: 12
        custom_equipment_type:
          description: Custom equipment type.
          type: string
          example: custom type
        book_it_now:
          description: Book it now related data.
          type: object
          $ref: '#/components/schemas/request_book_it_now_object'
        bid_duration_end_time:
          description: The Date and Time the Bid Duration will End in UTC. Supports yyyy-mm-ddThh:mm:ss format.
          type: string
          example: '2021-10-06T10:30:20'
        quote_watchers:
          description: Identify additional users within your organization to provide quote notifications.
          type: array
          items:
            description: Email.
            type: string
          example:
          - shipper@stonelogistics.com
          - emergetest@emergetms.com
    update_opportunity_request_object:
      type: object
      required:
      - stops
      - commodities
      - load_type_id
      - equipment_type_id
      properties:
        load_type_id:
          $ref: '#/components/schemas/request_load_type_id_object'
        equipment_type_id:
          $ref: '#/components/schemas/request_equipment_type_id_object'
        reefer_maximum_temperature:
          description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 20
        reefer_minimum_temperature:
          description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 1
        equipment_size:
          $ref: '#/components/schemas/equipment_size_object'
        request_all_network_partners:
          description: Defines if the opportunity is upon creation submitted to the network partners.
          type: boolean
          default: false
        is_hot_load:
          description: Identifies if the load is hot.
          type: boolean
          default: false
        is_tracking_required:
          description: Defines if tracking is required on this opportunity.
          type: boolean
          default: false
        cargo_value:
          description: The cargo value for this opportunity.
          type: number
          minimum: 1
          example: 100000
        assigned_user:
          description: Defines the user to whom the opportunity will be assigned. If not provided, it will be defaulted to
            the authenticated user.
          type: string
          format: email
          example: shipper@stonelogistics.com
        stops:
          $ref: '#/components/schemas/opportunity_request_stops_object'
        commodities:
          $ref: '#/components/schemas/request_commodities_object'
        accessorials:
          $ref: '#/components/schemas/request_accessorials_object'
        references:
          $ref: '#/components/schemas/request_references_object'
        notes:
          description: Opportunity notes.
          type: array
          items:
            properties:
              note:
                description: The specific note for the opportunity
                type: string
        tags:
          $ref: '#/components/schemas/tags_object'
        mileage_override:
          description: Miles to be overridden.
          type: integer
          example: 12
        custom_equipment_type:
          description: Custom equipment type.
          type: string
          example: custom type
        bid_duration_end_time:
          description: The Date and Time the Bid Duration will End in UTC. Supports yyyy-mm-ddThh:mm:ss format.
          type: string
          example: '2021-10-06T10:30:20'
    tenders:
      type: object
      required:
      - stops
      - commodities
      properties:
        load_type_id:
          $ref: '#/components/schemas/request_load_type_id_object'
        equipment_type_id:
          $ref: '#/components/schemas/request_equipment_type_id_object'
        reefer_maximum_temperature:
          description: The maximum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 20
        reefer_minimum_temperature:
          description: The minimum temperature for reefer in degree Fahrenheit. Only valid for Reefer equipment type.
          type: integer
          example: 1
        equipment_size:
          $ref: '#/components/schemas/equipment_size_object'
        is_hot_load:
          description: Identifies if the load is hot.
          type: boolean
          default: false
        is_tracking_required:
          description: Defines if tracking is required on this opportunity.
          type: boolean
          default: false
        stops:
          $ref: '#/components/schemas/stops_object'
        commodities:
          $ref: '#/components/schemas/request_commodities_object'
        accessorials:
          $ref: '#/components/schemas/request_accessorials_object'
        references:
          $ref: '#/components/schemas/request_references_object'
        notes:
          $ref: '#/components/schemas/notes_object'
        tags:
          $ref: '#/components/schemas/tags_object'
        option_id:
          description: The Id of the option that is to be tendered against.
          type: integer
          example: 323324
          minimum: 1
        opportunity_id:
          description: The opportunity identifier.
          type: integer
          example: 213698
          minimum: 1
        mileage_override:
          description: Miles to be overridden.
          type: integer
          example: 12
        custom_equipment_type:
          description: Custom equipment type.
          type: string
          example: custom type
    request_accessorials_object:
      description: The accessorials associated with the load.
      type: array
      items:
        type: object
        properties:
          accessorial_type_id:
            description: The type of accessorial required.<br /><span>Enum:</span> <div style="height:80px; overflow-y:scroll">
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Straps"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "ETracks"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "LoadLocks"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "BlockAndBrace"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Blankets"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "DriverLoadAssist"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "DriverTailgateAssist"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "EdgeProtector"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "BulkHeads"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "SmokedTarps"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "StandardTarps"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "VBoards"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "CoilRacks"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "PipeStakes"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Headboard"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Dunnage"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Ramps"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "LoadLevelers"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Chains"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Other"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "TeamDrivers"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "PreCool"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "WoodenFloor"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "PersonalProtectiveEquipment"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "FtlInsideDelivery"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "Liftgate"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "FoodGrade"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "TWICRequired"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "TankerEndorsement"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "ProtectFromFreeze"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "LightScaleTicketRequired"</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> "PalletJack"</span>
              </div>
            type: string
            example: Blankets
          value:
            description: The accessorial quantity.
            type: string
            example: '1'
    accessorials_object:
      description: The accessorials associated with the load.
      type: array
      items:
        type: object
        properties:
          accessorial_type_id:
            description: The type of accessorial required.<br /><span>Enum:</span> <div style="height:80px; overflow-y:scroll">
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Straps":127}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"ETracks":128}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"LoadLocks":129}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"BlockAndBrace":130}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Blankets":131}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"DriverLoadAssist":132}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"DriverTailgateAssist":133}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"EdgeProtector":134}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"BulkHeads":135}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"SmokedTarps":136}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"StandardTarps":137}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"VBoards":138}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"CoilRacks":139}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"PipeStakes":140}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Headboard":141}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Dunnage":142}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Ramps":143}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"LoadLevelers":144}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Chains":145}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Other":146}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"TeamDrivers":147}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"PreCool":148}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"WoodenFloor":153}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"PersonalProtectiveEquipment":154}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"FtlInsideDelivery":155}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"Liftgate":156}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"FoodGrade":157}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"TWICRequired":158}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"TankerEndorsement":159}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"ProtectFromFreeze":160}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"LightScaleTicketRequired":161}</span>
              <span style="color:rgb(62 65 68); border-radius:4px; padding:1px 5px; border:1px solid rgb(228, 231, 235); font-size:12px;
              font-family:'Source Code Pro', monospace; line-height:1.2em; display:inline-flex; overflow-wrap:anywhere"> {"PalletJack":162}</span>
              </div>
            type: string
            example: 131
          value:
            description: The accessorial quantity.
            type: string
            example: '1'
    request_book_it_now_object:
      description: Book it now related data.
      type: object
      properties:
        enabled:
          description: Defines if Book it Now will populate n a quote upon creation. This overrides the “Set Dynamic BIN using
            the default starting and ceiling rates for API and Bulk Upload quotes” organization setting.
          type: boolean
          default: false
          example: false
        start:
          description: Starting price for dynamic book it now. When not provided, the starting rate will calculate based on
            the rate pulse or ceiling rate.
          type: integer
        ceiling:
          description: Ceiling price for the dynamic book it now.
          type: integer
    response_book_it_now_object:
      description: Book it now related data.
      type: object
      properties:
        enabled:
          description: Defines if Book it Now will populate n a quote upon creation. This overrides the “Set Dynamic BIN using
            the default starting and ceiling rates for API and Bulk Upload quotes” organization setting.
          type: boolean
          default: false
          example: false
        price:
          description: Book it now price.
          type: integer
        start:
          description: Starting dynamic book book it now price. Must be paired with the ceiling rate to set Dynamic Book it
            Now.
          type: integer
        ceiling:
          description: Ceiling dynamic book book it now price. Must be paired with the start rate to set Dynamic Book it Now.
          type: integer
    request_commodities_object:
      description: A description of the items to be carried by the capacity provider.
      type: array
      items:
        type: object
        required:
        - name
        - weight
        properties:
          id:
            description: The commodity identifier.
            type: integer
            default: 0
          name:
            description: The name and description of the commodity.
            type: string
            example: FAK
          weight:
            description: The weight of the commodity in lbs.
            type: integer
            example: 100
          quantity_unit_id:
            description: The type of unit the commodity is moved on.
            type: string
            enum:
            - Other
            - Pallet
            - Box
            - Crate
            - Bag
            - Coils
            - Drums
            - Reels
            - Rolls
            - TubesOrPipes
            - Slipsheets
            - Bale
            - Bucket
            - Bundle
            - Can
            - Carton
            - Case
            - Cylinder
            - Pail
            - Pieces
            - Skid
            example: Other
          unit_count:
            description: The unit count of the commodity.
            type: integer
            example: 2
          piece_count:
            description: The piece count of the commodity.
            type: integer
            example: 24
          length:
            description: The length of the commodity.
            type: integer
            example: 48
          width:
            description: The width of the commodity.
            type: integer
            example: 40
          height:
            description: The height of the commodity.
            type: integer
            example: 60
          is_stackable:
            description: Flag identifying a stackable commodity. Default value is false.
            type: boolean
            default: false
            example: false
          is_hazmat:
            description: Flag identifying a hazmat commodity. Default value is false.
            type: boolean
            default: false
            example: true
          hazmat:
            type: object
            properties:
              identification_number:
                description: The hazmat identification number for the dangerous substances.
                type: string
                example: UN1000
              packing_group_id:
                description: The packing group identifier for the hazmat load.
                enum:
                - High
                - Moderate
                - Low
                - None
                type: string
                example: High
              class_id:
                description: The class of the hazmat load
                enum:
                - MassExplosiveHazard
                - ProjectionHazard
                - MassFireHazard
                - MinorExplosionHazard
                - VeryInsensitiveExplosives
                - ExtremelyInsensitiveExplosives
                - FlammableGases
                - NonFlammableGases
                - PoisonousOrToxic
                - CombustibleLiquids
                - FlammableSolid
                - SpontaneouslyCombustibleMaterial
                - DangerousWhenWet
                - Oxidizer
                - OrganicPeroxide
                - PoisonousOrToxicMaterial
                - InfectiousSubstance
                - RadioactiveMaterial
                - Corrosives
                - MiscellaneousDangerousGoods
                type: string
                example: ExtremelyInsensitiveExplosives
              emergency_contact:
                description: The person to be contacted regarding an emergency with this Hazmat load.
                type: object
                properties:
                  name:
                    description: The name of the contact responsible for the hazmat load.
                    type: string
                    example: Kyle Jepsen
                  phone:
                    description: The phone number of the emergency contact.
                    $ref: '#/components/schemas/phone_response_object'
    commodities_object:
      description: A description of the items to be carried by the capacity provider.
      type: array
      items:
        type: object
        required:
        - name
        - weight
        properties:
          id:
            description: The commodity identifier.
            type: integer
            default: 0
          name:
            description: The name and description of the commodity.
            type: string
            example: FAK
          weight:
            description: The weight of the commodity in lbs.
            type: integer
            example: 100
          quantity_unit_id:
            description: The type of unit the commodity is moved on.
            type: string
            enum:
            - Other: 0
            - Pallet: 1
            - Box: 2
            - Crate: 3
            - Bag: 4
            - Coils: 5
            - Drums: 6
            - Reels: 7
            - Rolls: 8
            - TubesOrPipes: 9
            - Slipsheets: 10
            - Bale: 11
            - Bucket: 12
            - Bundle: 13
            - Can: 14
            - Carton: 15
            - Case: 16
            - Cylinder: 17
            - Pail: 18
            - Pieces: 19
            - Skid: 20
            example: 0
          unit_count:
            description: The unit count of the commodity.
            type: integer
            example: 2
          piece_count:
            description: The piece count of the commodity.
            type: integer
            example: 24
          length:
            description: The length of the commodity.
            type: integer
            example: 48
          width:
            description: The width of the commodity.
            type: integer
            example: 40
          height:
            description: The height of the commodity.
            type: integer
            example: 60
          is_stackable:
            description: Flag identifying a stackable commodity. Default value is false.
            type: boolean
            default: false
            example: false
          is_hazmat:
            description: Flag identifying a hazmat commodity. Default value is false.
            type: boolean
            default: false
            example: true
          hazmat:
            type: object
            properties:
              identification_number:
                description: The hazmat identification number for the dangerous substances.
                type: string
                example: UN1000
              packing_group_id:
                description: The packing group identifier for the hazmat load.
                enum:
                - High: 1
                - Moderate: 2
                - Low: 3
                - None: 4
                type: string
                example: 1
              class_id:
                description: The class of the hazmat load
                enum:
                - MassExplosiveHazard: 1
                - ProjectionHazard: 2
                - MassFireHazard: 3
                - MinorExplosionHazard: 4
                - VeryInsensitiveExplosives: 5
                - ExtremelyInsensitiveExplosives: 6
                - FlammableGases: 7
                - NonFlammableGases: 8
                - PoisonousOrToxic: 9
                - CombustibleLiquids: 10
                - FlammableSolid: 11
                - SpontaneouslyCombustibleMaterial: 12
                - DangerousWhenWet: 13
                - Oxidizer: 14
                - OrganicPeroxide: 15
                - PoisonousOrToxicMaterial: 16
                - InfectiousSubstance: 17
                - RadioactiveMaterial: 18
                - Corrosives: 19
                - MiscellaneousDangerousGoods: 20
                type: string
                example: 6
              emergency_contact:
                description: The person to be contacted regarding an emergency with this Hazmat load.
                type: object
                properties:
                  name:
                    description: The name of the contact responsible for the hazmat load.
                    type: string
                    example: Kyle Jepsen
                  phone:
                    description: The phone number of the emergency contact.
                    $ref: '#/components/schemas/phone_response_object'
    equipment_size_object:
      description: The length of the trailer.
      type: integer
      minimum: 1
      example: 2
    length_of_haul_result_object:
      description: The length of haul override.
      type: object
      properties:
        manual:
          type: integer
          example: 2
    errorcode_zero_object:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
            messages:
              description: Error messages
              type: array
              items:
                type: string
                example: No message
    errorcode_zero_without_message_object:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: HTTP code
              type: integer
              example: 0
    errorcode_zero:
      type: object
      properties:
        code:
          description: HTTP code
          type: integer
          example: 0
    notes_object:
      type: array
      items:
        description: This shipment is ready to go now. Please provide your best options.
        properties:
          note:
            description: The specific note for the opportunity
            type: string
    request_references_object:
      required:
      - Customer
      description: References for the opportunity.
      type: array
      items:
        type: object
        properties:
          type_id:
            description: The type of reference.
            type: string
            enum:
            - Other
            - Customer
            - Appointment
            - Bol
            - Delivery
            - Pickup
            - PickupConfirmation
            - Po
            - Pro
            - Trailer
            example: Customer
          value:
            description: The reference value.
            type: string
            example: CustRef123
    references_object:
      required:
      - Customer
      description: References for the opportunity.
      type: array
      items:
        type: object
        properties:
          type_id:
            description: The type of reference.
            type: string
            enum:
            - Other: 1
            - Customer: 2
            - Appointment: 3
            - Bol: 4
            - Delivery: 5
            - Pickup: 6
            - PickupConfirmation: 7
            - Po: 8
            - Pro: 9
            - Trailer: 10
            example: 2
          value:
            description: The reference value.
            type: string
            example: CustRef123
    opportunity_response_stops_object:
      description: The stops associated with the opportunity. An opportunity must have at least two stops.
      type: array
      items:
        type: object
        required:
        - order
        - action_type_id
        - postal_code
        - city
        - state
        - country
        - appointment_type_id
        properties:
          type_id:
            description: The type of the stop.
            type: string
            enum:
            - Origin: 1
            - Middle: 2
            - Destination: 3
            example: 1
          appointment_type_id:
            description: The appointment type.
            type: string
            deprecated: true
            enum:
            - FCFS: 1
            - Appointment: 2
            example: 1
          standardized_appointment_type_id:
            description: The appointment type of the stop.
            type: string
            enum:
            - FCFS: 1
            - AppointmentScheduled: 2
            - AppointmentRequired: 3
            example: 1
          standardized_loading_type_id:
            description: The loading or unloading type of the stop.
            type: string
            enum:
            - Live: 1
            - DropTrailer: 2
            example: 1
          address1:
            type: string
            example: 3665 North Harbor Drive
          address2:
            type: string
            example: string
          city:
            type: string
            example: San Diego
          contact:
            type: object
            properties:
              name:
                description: The contact name for the person at the stop.
                type: string
                example: Shipper
              phone:
                description: The phone number for the contact at the stop.
                $ref: '#/components/schemas/phone_response_object'
              email:
                type: string
                format: email
                example: shipper@stonelogistics.com
          country:
            description: The country of the stop. Use abbreviation US or USA for United States of America and CA or CAN for
              Canada.
            type: string
            example: US
          state:
            description: The state of the stop. Use abbreviation.
            type: string
            example: CA
          postal_code:
            type: string
            example: '92101'
          latitude:
            description: The latitude of the stop (use decimal representation)
            type: number
            example: 32.7325
          longitude:
            description: The longitude of the stop (use decimal representation)
            type: number
            example: -117.2011
          name:
            description: The name for the stop.
            type: string
            example: Stone Brewing Company
          note:
            description: Notes associated with the stop.
            type: string
            example: Check in with security prior to loading or unloading.
          order:
            description: The order of the stop-starting with 1.
            type: integer
            example: 1
          action_type_id:
            description: The stop action.
            type: string
            enum:
            - Pick: 1
            - Drop: 2
            example: 1
          schedule:
            description: The schedule associated with the stop.
            type: object
            deprecated: true
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          standardized_schedule:
            description: The schedule associated with the stop.
            type: object
            properties:
              start_date:
                description: The earliest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_date:
                description: The latest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-07'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          raw_address:
            description: A string version of the full address
            type: string
            example: 23, Phoenix
          is_schedule_required:
            description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf. Not recommended
              for the marketplace workflow
            type: boolean
            deprecated: true
            example: false
    invite_by_tag_object:
      description: Defines the network partner tags to whom the opportunity has to be posted. This will be ignored if `request_all_network_partners`
        is passed as `true`.
      type: array
      items:
        type: string
        example: firstTag
    opportunity_request_stops_object:
      description: The stops associated with the opportunity. An opportunity must have at least two stops.
      type: array
      items:
        type: object
        required:
        - order
        - action_type_id
        - postal_code
        - city
        - state
        - country
        - appointment_type_id
        - standardized_appointment_type_id
        - standardized_loading_type_id
        properties:
          type_id:
            description: The type of the stop.
            type: string
            enum:
            - Origin
            - Middle
            - Destination
            example: Origin
          appointment_type_id:
            description: The appointment type.
            type: string
            deprecated: true
            enum:
            - FCFS
            - Appointment
            example: Appointment
          standardized_appointment_type_id:
            description: The appointment type of the stop.
            type: string
            enum:
            - FCFS
            - AppointmentScheduled
            - AppointmentRequired
            example: FCFS
          standardized_loading_type_id:
            description: The loading or unloading type of the stop.
            type: string
            enum:
            - Live
            - DropTrailer
            example: Live
          address1:
            type: string
            example: 3665 North Harbor Drive
          address2:
            type: string
            example: string
          city:
            type: string
            example: San Diego
          contact:
            type: object
            properties:
              name:
                description: The contact name for the person at the stop.
                type: string
                example: Shipper
              phone:
                description: The phone number for the contact at the stop.
                $ref: '#/components/schemas/phone_response_object'
              email:
                type: string
                format: email
                example: shipper@stonelogistics.com
          country:
            description: The country of the stop. Use abbreviation US or USA for United States of America and CA or CAN for
              Canada.
            type: string
            example: US
          state:
            description: The state of the stop. Use abbreviation.
            type: string
            example: CA
          postal_code:
            type: string
            example: '92101'
          latitude:
            description: The latitude of the stop (use decimal representation)
            type: number
            example: 32.7325
          longitude:
            description: The longitude of the stop (use decimal representation)
            type: number
            example: -117.2011
          name:
            description: The name for the stop.
            type: string
            example: Stone Brewing Company
          note:
            description: Notes associated with the stop.
            type: string
            example: Check in with security prior to loading or unloading.
          order:
            description: The order of the stop-starting with 1.
            type: integer
            example: 1
          action_type_id:
            description: The stop action.
            type: string
            enum:
            - Pick
            - Drop
            example: Pick
          schedule:
            description: The schedule associated with the stop.
            type: object
            deprecated: true
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          standardized_schedule:
            description: The schedule associated with the stop.
            type: object
            properties:
              start_date:
                description: The earliest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_date:
                description: The latest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-07'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          raw_address:
            description: A string version of the full address
            type: string
            example: 23, Phoenix
          is_schedule_required:
            description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf. Not recommended
              for the marketplace workflow
            type: boolean
            deprecated: true
            example: false
    stops_object:
      description: The stops associated with the opportunity. An opportunity must have at least two stops.
      type: array
      items:
        type: object
        required:
        - order
        - name
        - address1
        - address2
        - city
        - state
        - country
        properties:
          type_id:
            description: The type of the stop.
            type: string
            enum:
            - Origin
            - Middle
            - Destination
            example: Origin
          appointment_type_id:
            description: The appointment type.
            type: string
            deprecated: true
            enum:
            - FCFS
            - Appointment
            example: Appointment
          standardized_appointment_type_id:
            description: The appointment type of the stop.
            type: string
            enum:
            - FCFS
            - AppointmentScheduled
            - AppointmentRequired
            example: FCFS
          standardized_loading_type_id:
            description: The loading or unloading type of the stop.
            type: string
            enum:
            - Live
            - DropTrailer
            example: Live
          address1:
            type: string
            example: 3665 North Harbor Drive
          address2:
            type: string
            example: string
          city:
            type: string
            example: San Diego
          contact:
            type: object
            properties:
              name:
                description: The contact name for the person at the stop.
                type: string
                example: Shipper
              phone:
                description: The phone number for the contact at the stop.
                $ref: '#/components/schemas/phone_response_object'
              email:
                type: string
                format: email
                example: shipper@stonelogistics.com
          country:
            description: The country of the stop. Use abbreviation US or USA for United States of America and CA or CAN for
              Canada.
            type: string
            example: US
          state:
            description: The state of the stop. Use abbreviation.
            type: string
            example: CA
          postal_code:
            type: string
            example: '92101'
          latitude:
            description: The latitude of the stop (use decimal representation)
            type: number
            example: 32.7325
          longitude:
            description: The longitude of the stop (use decimal representation)
            type: number
            example: -117.2011
          name:
            description: The name for the stop.
            type: string
            example: Stone Brewing Company
          note:
            description: Notes associated with the stop.
            type: string
            example: Check in with security prior to loading or unloading.
          order:
            description: The order of the stop-starting with 1.
            type: integer
            example: 1
          action_type_id:
            description: The stop action.
            type: string
            enum:
            - Pick
            - Drop
            example: Pick
          schedule:
            description: The schedule associated with the stop.
            type: object
            deprecated: true
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          standardized_schedule:
            description: The schedule associated with the stop.
            type: object
            properties:
              start_date:
                description: The earliest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_date:
                description: The latest date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-07'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          raw_address:
            description: A string version of the full address
            type: string
            example: 23, Phoenix
          is_schedule_required:
            description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf. Not recommended
              for the marketplace workflow
            type: boolean
            deprecated: true
            example: false
    location_object:
      description: The location address details.
      type: object
      required:
      - address1
      - city
      - state
      - country
      - postal_code
      properties:
        name:
          description: Name for the location.
          type: string
          example: Stone Brewing Company
        address1:
          description: Address1 line for the location.
          type: string
          example: 3665 North Harbor Drive
        address2:
          description: Address2 line for the location.
          type: string
          example: Suite 3100
        city:
          description: City of the location.
          type: string
          example: San Diego
        state:
          description: State of the location. Use abbreviation.
          type: string
          example: CA
        country:
          description: Country of the location. Use abbreviation US or USA for United States of America and CA or CAN for
            Canada.
          type: string
          example: US
        postal_code:
          description: Postal code of the location. Supports upto 10 characters.
          type: string
          example: '92101'
        raw_address:
          description: Raw address of the location.
          type: string
          example: Stone Brewing Company, 3665 North Harbor Drive, Suite 3100, San Diego, CA, 92101, US
        latitude:
          description: Latitude of the location (use Decimal Degrees form)
          type: number
          example: 32.7325
        longitude:
          description: Longitude of the location (use Decimal Degrees form)
          type: number
          example: -117.2011
    request_load_type_id_object:
      description: The load type identifier.
      type: string
      enum:
      - FTL
      example: FTL
    load_type_id_object:
      description: The load type identifier.
      type: string
      enum:
      - FTL: 1
      example: 1
    request_equipment_type_id_object:
      description: The equipment type identifier.
      type: string
      enum:
      - Other
      - Flatbed
      - Reefer
      - Stepdeck
      - Rgn
      - Van
      - Drayage
      - Dump
      - VanOrReefer
      - TrailerPoolInterchange
      - PowerOnly
      - Conestoga
      - MaxiTrailer
      - Intermodal
      - BoxTruck
      - Hotshot
      - SprinterVan
      - StraightTruck
      example: Van
    equipment_type_id_object:
      description: The equipment type identifier.
      type: string
      enum:
      - Other: 0
      - Flatbed: 1
      - Reefer: 3
      - Stepdeck: 4
      - Rgn: 5
      - Van: 6
      - Drayage: 7
      - Dump: 8
      - VanOrReefer: 9
      - TrailerPoolInterchange
      - 10
      - PowerOnly: 11
      - Conestoga: 12
      - MaxiTrailer: 38
      - Intermodal: 82
      - BoxTruck: 84
      - Hotshot: 85
      - SprinterVan: 86
      - StraightTruck: 87
      example: 6
    tags_object:
      description: Tags specific to the entity.
      type: array
      items:
        type: string
        example: firstTag
    200_getawards_partner_response:
      type: object
      description: 200 | OK. Details of the partner winning the award
      properties:
        partner_code:
          description: Partner code of the winning partner as assigned by shipment provider.
          type: string
          example: P2314534
        transportation_entity:
          description: Details of the transportation entity associated with the winning partner .
          type: object
          properties:
            legal_name:
              description: Transportation entity legal name.
              type: integer
              example: name
            dba_name:
              description: Transportation entity dba name.
              type: string
              example: testName
            dot_number:
              description: Transportation entity DOT number.
              type: integer
              example: 2894801
            docket_number:
              description: Transportation entity Docket number.
              type: string
              example: MC143583
            type:
              description: Transportation entity type.
              type: string
              example: testType
        contact:
          description: Contact information of the winning partner.
          type: object
          properties:
            first_name:
              description: First name of the contact.
              type: string
              example: FirstName
            last_name:
              description: Last name of the contact.
              type: string
              example: LastName
            email:
              description: Email of the contact.
              type: string
              format: email
              example: example@emergetms.com
            phone:
              description: Phone details of the contact.
              $ref: '#/components/schemas/phone_response_object'
    200_getoption_partner_response:
      type: object
      description: Details of the partner associated with the option
      properties:
        partner_code:
          description: Partner code of partner.
          type: string
          example: P2314534
        transportation_entity:
          description: Details of the transportation entity associated with the partner.
          type: object
          properties:
            legal_name:
              description: Transportation entity legal name.
              type: integer
              example: Hansal Transport
            dba_name:
              description: Transportation entity dba name.
              type: string
              example: HansalTransport
            dot_number:
              description: Transportation entity DOT number.
              type: integer
              example: 2894801
            docket_number:
              description: Transportation entity Docket number.
              type: string
              example: MC143583
            type:
              description: Transportation entity type.
              type: string
              example: testType
        contact:
          description: Contact information of the winning partner.
          type: object
          properties:
            first_name:
              description: First name of the contact.
              type: string
              example: FirstName
            last_name:
              description: Last name of the contact.
              type: string
              example: LastName
            email:
              description: Email of the contact.
              type: string
              format: email
              example: example@emergetms.com
            phone:
              description: Phone details of the contact.
              $ref: '#/components/schemas/phone_response_object'
    200_sendrequest_partners_response:
      type: array
      items:
        type: object
        properties:
          partner_id:
            description: Id of the network partner to whom request could not be sent.
            type: integer
            example: 3456
          partner_code:
            description: Partner code of the network partner to whom request could not be sent.
            type: string
            example: AS1234
          error:
            description: Reason for not sending the request.
            type: string
            example: The request cannot be processed as the request is already sent or the option has been received for the
              given partner id/code.
    webhooks:
      type: object
      description: Details of the webhook.
      required:
      - url
      - content_type
      - event_types
      properties:
        authentication:
          description: Credentials that Emerge system will send using Basic authentication scheme when calling the webhook
            for the subscribed event(s).
          type: object
          properties:
            is_enabled:
              description: Authentication user status .
              type: boolean
              default: false
              example: true
            username:
              description: Authentication username.
              type: string
              example: username
            password:
              description: Authentication password.
              type: string
              example: password
        custom_headers:
          description: An object containing a set of key-value pairs. For each pair defined in this object, a custom HTTP
            header is sent in the webhook call for the subscribed event(s). The key becomes the header name, while the value
            is added as the header value. A possible use case for this feature is when the customer expects each webhook call
            to have a security key for authentication on their end.
          type: object
          example:
            x-api-key: 070C895C-AE61-4629-A603-829FC54CD816
        form_data:
          type: object
          description: Object to define the form data format when content type is FormData.
          properties:
            payload_property_name:
              description: FormData property name for the payload
              type: string
              example: payload
            payload_type:
              description: The payload data format when content type is FormData
              type: string
              default: JSON
              enum:
              - JSON
              - XML
            addon_properties:
              description: A simple JSON object containing a set of key-value pairs. Each of these key-value pairs will be
                added to the webhook call payload in addition to the event data information.
              type: object
              example:
                process_id: 34809f4d-75b1-431e-a367-bea47e48636c
        content_type:
          description: Request content type.
          type: string
          enum:
          - application/json
          - application/x-www-form-urlencoded
        event_types:
          description: Subscribed event types for the webhook. Note that the API allows multiple subscriptions for any given
            event type(s) without any duplicate subscription checks. Although this flexibility is required by some consumers
            for handling certain special cases, duplicate subscription is not recommended in general and should be safeguarded
            against. If a consumer receives duplicate webhook calls for a single event, a duplicate webhook subscribed by
            mistake could be the root cause.
          type: array
          items:
            $ref: '#/components/schemas/webhook_event_types'
        is_enabled:
          description: Flag to control publishing of the events on webhook Url.
          type: boolean
          default: false
          example: true
        url:
          description: URL of the webhook as hosted by the consumer (shipper organization).
          type: string
          example: webhook_url
    201_createwebhook_response:
      type: object
      description: 201 | Success. Details of the webhook
      properties:
        response:
          description: Response of the webhook creation.
          type: object
          properties:
            authentication:
              description: Credentials that Emerge system will send using Basic authentication scheme when calling the webhook
                for the subscribed event(s)
              type: object
              properties:
                is_enabled:
                  description: Authentication user status .
                  type: boolean
                  example: true
                username:
                  description: Authentication username.
                  type: string
                  example: username
                password:
                  description: Authentication password.
                  type: string
                  example: password
            custom_headers:
              description: An object containing a set of key-value pairs. For each pair defined in this object, a custom HTTP
                header is sent in the webhook call for the subscribed event(s). The key becomes the header name, while the
                value is added as the header value. A possible use case for this feature is when the customer expects each
                webhook call to have a security key for authentication on their end.
              type: object
              example:
                x-api-key: 070C895C-AE61-4629-A603-829FC54CD816
            form_data:
              type: object
              description: Object to define the form data format when content type is FormData.
              properties:
                payload_property_name:
                  description: FormData property name for the payload
                  type: string
                  example: payload
                payload_type:
                  description: The payload data format when content type is FormData
                  type: string
                  default: JSON
                  enum:
                  - JSON
                  - XML
                addon_properties:
                  description: A simple JSON object containing a set of key-value pairs. Each of these key-value pairs will
                    be added to the webhook call payload in addition to the event data information.
                  type: object
                  example:
                    process_id: 34809f4d-75b1-431e-a367-bea47e48636c
            content_type:
              description: Request content type.
              type: string
              enum:
              - application/json
              - application/x-www-form-urlencoded
            event_types:
              description: Subscribed event types for the webhook. Note that the API allows multiple subscriptions for any
                given event type(s) without any duplicate subscription checks. Although this flexibility is required by some
                consumers for handling certain special cases, duplicate subscription is not recommended in general and should
                be safeguarded against. If a consumer receives duplicate webhook calls for a single event, a duplicate webhook
                subscribed by mistake could be the root cause.
              type: array
              items:
                $ref: '#/components/schemas/webhook_event_types'
            id:
              description: Guid of the webhook.
              type: string
              example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
            is_enabled:
              description: Status of the webhook.
              type: boolean
              example: true
            url:
              description: URL of the webhook as hosted by the consumer (shipper organization).
              type: string
              example: webhook_url
            created_date:
              description: Created date of the webhook.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
            modified_date:
              description: Modified date of the webhook.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    200_getwebhooks_response:
      type: object
      description: 200 | OK. Details of the webhook
      properties:
        response:
          description: Response of the webhook creation.
          type: array
          items:
            type: object
            properties:
              authentication:
                description: Credentials that Emerge system will send using Basic authentication scheme when calling the webhook
                  for the subscribed event(s)
                type: object
                properties:
                  is_enabled:
                    description: Authentication user status .
                    type: boolean
                    example: true
                  username:
                    description: Authentication username.
                    type: string
                    example: username
                  password:
                    description: Authentication password.
                    type: string
                    example: password
              custom_headers:
                description: An object containing a set of key-value pairs. For each pair defined in this object, a custom
                  HTTP header is sent in the webhook call for the subscribed event(s). The key becomes the header name, while
                  the value is added as the header value. A possible use case for this feature is when the customer expects
                  each webhook call to have a security key for authentication on their end.
                type: object
                example:
                  x-api-key: 070C895C-AE61-4629-A603-829FC54CD816
              form_data:
                type: object
                description: Object to define the form data format when content type is FormData.
                properties:
                  payload_property_name:
                    description: FormData property name for the payload
                    type: string
                    example: payload
                  payload_type:
                    description: The payload data format when content type is FormData
                    type: string
                    default: JSON
                    enum:
                    - JSON
                    - XML
                  addon_properties:
                    description: A simple JSON object containing a set of key-value pairs. Each of these key-value pairs will
                      be added to the webhook call payload in addition to the event data information.
                    type: object
                    example:
                      process_id: 34809f4d-75b1-431e-a367-bea47e48636c
              content_type:
                description: Request content type.
                type: string
                enum:
                - application/json
                - application/x-www-form-urlencoded
              event_types:
                description: Subscribed event types for the webhook. Note that the API allows multiple subscriptions for any
                  given event type(s) without any duplicate subscription checks. Although this flexibility is required by
                  some consumers for handling certain special cases, duplicate subscription is not recommended in general
                  and should be safeguarded against. If a consumer receives duplicate webhook calls for a single event, a
                  duplicate webhook subscribed by mistake could be the root cause.
                type: array
                items:
                  $ref: '#/components/schemas/webhook_event_types'
              id:
                description: guid of the webhook.
                type: string
                example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
              is_enabled:
                description: Status of the webhook.
                type: boolean
                example: true
              url:
                description: URL of the webhook as hosted by the consumer (shipper organization).
                type: string
                example: webhook_url
              created_date:
                description: Created date of the webhook.
                type: string
                example: '2019-02-12T02:36:54.2973188+00:00'
              modified_date:
                description: Modified date of the webhook.
                type: string
                example: '2019-02-12T02:36:54.2973188+00:00'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    200_getwebhook_response:
      type: object
      description: 200 | OK. Details of the webhook
      properties:
        response:
          description: Response of the webhook.
          type: object
          properties:
            authentication:
              description: Credentials that Emerge system will send using Basic authentication scheme when calling the webhook
                for the subscribed event(s).
              type: object
              properties:
                is_enabled:
                  description: Authentication user status .
                  type: boolean
                  example: true
                username:
                  description: Authentication username.
                  type: string
                  example: username
                password:
                  description: Authentication password.
                  type: string
                  example: password
            custom_headers:
              description: An object containing a set of key-value pairs. For each pair defined in this object, a custom HTTP
                header is sent in the webhook call for the subscribed event(s). The key becomes the header name, while the
                value is added as the header value. A possible use case for this feature is when the customer expects each
                webhook call to have a security key for authentication on their end.
              type: object
              example:
                x-api-key: 070C895C-AE61-4629-A603-829FC54CD816
            form_data:
              type: object
              description: Object to define the form data format when content type is FormData.
              properties:
                payload_property_name:
                  description: FormData property name for the payload
                  type: string
                  example: payload
                payload_type:
                  description: The payload data format when content type is FormData
                  type: string
                  default: JSON
                  enum:
                  - JSON
                  - XML
                addon_properties:
                  description: A simple JSON object containing a set of key-value pairs. Each of these key-value pairs will
                    be added to the webhook call payload in addition to the event data information.
                  type: object
                  example:
                    process_id: 34809f4d-75b1-431e-a367-bea47e48636c
            content_type:
              description: Request content type.
              type: string
              enum:
              - application/json
              - application/x-www-form-urlencoded
            event_types:
              description: Subscribed event types for the webhook. Note that the API allows multiple subscriptions for any
                given event type(s) without any duplicate subscription checks. Although this flexibility is required by some
                consumers for handling certain special cases, duplicate subscription is not recommended in general and should
                be safeguarded against. If a consumer receives duplicate webhook calls for a single event, a duplicate webhook
                subscribed by mistake could be the root cause.
              type: array
              items:
                $ref: '#/components/schemas/webhook_event_types'
            id:
              description: Guid of the webhook.
              type: string
              example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
            is_enabled:
              description: Status of the webhook.
              type: boolean
              example: true
            url:
              description: URL of the webhook as hosted by the consumer (shipper organization).
              type: string
              example: webhook_url
            created_date:
              description: Created date of the webhook.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
            modified_date:
              description: Modified date of the webhook.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
        error:
          $ref: '#/components/schemas/errorcode_zero'
    updatewebhook:
      type: object
      description: Details of the webhook.
      required:
      - id
      - content_type
      - event_types
      - url
      properties:
        authentication:
          description: Credentials that Emerge system will send using Basic authentication scheme when calling the webhook
            for the subscribed event(s).
          type: object
          properties:
            is_enabled:
              description: Authentication user status .
              type: boolean
              example: true
            username:
              description: Basic authentication username.
              type: string
              example: username
            password:
              description: Basic authentication password.
              type: string
              example: password
        custom_headers:
          description: An object containing a set of key-value pairs. For each pair defined in this object, a custom HTTP
            header is sent in the webhook call for the subscribed event(s). The key becomes the header name, while the value
            is added as the header value. A possible use case for this feature is when the customer expects each webhook call
            to have a security key for authentication on their end.
          type: object
          example:
            x-api-key: 070C895C-AE61-4629-A603-829FC54CD816
        form_data:
          type: object
          description: Object to define the form data format when content type is FormData.
          properties:
            payload_property_name:
              description: FormData property name for the payload
              type: string
              example: payload
            payload_type:
              description: The payload data format when content type is FormData
              type: string
              default: JSON
              enum:
              - JSON
              - XML
            addon_properties:
              description: A simple JSON object containing a set of key-value pairs. Each of these key-value pairs will be
                added to the webhook call payload in addition to the event data information.
              type: object
              example:
                process_id: 34809f4d-75b1-431e-a367-bea47e48636c
        content_type:
          description: Request content type.
          type: string
          enum:
          - application/json
          - application/x-www-form-urlencoded
        event_types:
          description: Subscribed event types for the webhook. Note that the API allows multiple subscriptions for any given
            event type(s) without any duplicate subscription checks. Although this flexibility is required by some consumers
            for handling certain special cases, duplicate subscription is not recommended in general and should be safeguarded
            against. If a consumer receives duplicate webhook calls for a single event, a duplicate webhook subscribed by
            mistake could be the root cause.
          type: array
          items:
            $ref: '#/components/schemas/webhook_event_types'
        is_enabled:
          description: Flag to control publishing of the events on webhook Url.
          type: boolean
          example: true
        url:
          description: URL of the webhook as hosted by the consumer (shipper organization).
          type: string
          example: webhook_url
        id:
          description: Guid of the webhook.
          type: string
          example: 2bc9eec8-0a66-4e0f-9103-ff4f6ad4ae68
    emergency_contact_object:
      description: Emergency contact object.
      type: object
      properties:
        name:
          description: The name of the emergency contact
          type: string
          example: testname
        phone:
          description: The contact info for the emergency contact.
          type: string
          example: 1234567890-1234
    hazmat_object:
      description: Hazmat object.
      type: object
      properties:
        identification_number:
          description: The Id of the tender
          type: integer
          example: 12
        packing_group_id:
          description: The hazmat packing group
          type: string
          example: '1'
        class_id:
          description: The hazmat class identifier
          type: string
          example: '50'
        emergency_contact:
          description: The emergency contact for the hazardous commodity
          type: object
    opportunities_object:
      type: object
      required:
      - stops
      - notes
      - commodities
      - load_type_id
      - equipment_type_id
      properties:
        assigned_user_id:
          description: The Id of the user that is assigned to this object within the Emerge system. //Emerge is removing this
            as a required value, it will default to the authenticated user//
          type: integer
          example: 34
        id:
          description: The Emerge Id associated with the entity
          type: integer
          example: 43
        length_of_haul:
          description: The length of haul of the shipment in miles
          type: integer
          example: 766
        created_date:
          description: The date/time the entity was created
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        modified_date:
          description: The date/time the entity was updated
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        reference:
          description: The date/time the assignment
          type: string
          example: '433333'
        type_id:
          description: Type id of opportunity
          type: string
          example: LTL
        is_priced_at:
          description: Identify if a target rate should be applied. Defaulted to false if not provided
          type: boolean
          example: false
        priced_at:
          description: The target rate value
          type: integer
          example: 345
        is_deleted:
          description: A flag to identify if a tender has been deleted
          type: boolean
          example: false
        assigned_user:
          description: The assigned users details. See the assigned user object for more details
          type: object
        option_count:
          description: Type id of opportunity
          type: string
          example: LTL
        shipments:
          description: Brief details about the shipments associated with this opportunity
          type: object
        is_posting:
          description: Determines if the shipment is posted or not. if not provided this defaults to false
          type: boolean
          example: true
        load_type_id:
          $ref: '#/components/schemas/load_type_id_object'
        equipment_type_id:
          $ref: '#/components/schemas/equipment_type_id_object'
        equipment_size:
          $ref: '#/components/schemas/equipment_size_object'
        search_in_marketplace:
          description: Defines if the opportunity is upon creation submitted to the Emerge marketplace.
          type: boolean
        request_all_network_partners:
          description: Defines if the opportunity is upon creation submitted to the network partners.
          type: boolean
        is_hot_load:
          description: Identifies if the load is hot.
          type: boolean
          default: false
        is_tracking_required:
          description: Defines if tracking is required on this opportunity.
          type: boolean
          default: false
        stops:
          $ref: '#/components/schemas/stops_object'
        commodities:
          $ref: '#/components/schemas/commodities_object'
        accessorials:
          $ref: '#/components/schemas/accessorials_object'
        references:
          $ref: '#/components/schemas/references_object'
        notes:
          description: Opportunity notes.
          type: array
          items:
            properties:
              note:
                description: The specific note for the opportunity
                type: string
        tags:
          $ref: '#/components/schemas/tags_object'
    opportunity_response_stops_schedulle_object:
      description: Opportunity Stops Schedule Object.
      type: object
      properties:
        date:
          description: The stop date, local to the stop. Supports yyyy-mm-dd format.
          type: string
          example: '2021-10-06'
        start_time:
          description: The earliest time the load is available, local to the stop. Supports format hh:mm:ss
          type: string
          example: '14:00:00'
        end_time:
          description: The earliest time the load is available, local to the stop. Supports format hh:mm:ss
          type: string
          example: '20:00:00'
    opportunity_response_stops_contact_object:
      description: Opportunity Stops Contact Object.
      type: object
      properties:
        name:
          description: The contact name for the stop
          type: string
          example: name
        phone:
          description: The phone number for the contact
          $ref: '#/components/schemas/phone_response_object'
        email:
          description: The email for the contact
          type: string
          format: email
          example: example@emergetms.com
    options_object:
      description: Options Object.
      type: object
      properties:
        type_id:
          description: The type of reference. See the Option Type Object for more details
          type: string
          example: TypeId
        partner_id:
          description: The Id of the partner in the emerge system
          type: integer
        rate_pre_mile:
          description: The rate per mile that will be charged to the shipper. This will be generated if left empty
          type: number
          example: 551.33
        availability_date:
          type: string
          example: '2021-09-21T16:17:31.8333705+00:00'
        created_date:
          type: string
          example: '2021-09-21T16:17:31.8333705+00:00'
        modified_date:
          type: string
          example: '2021-09-21T16:17:49.5156372+00:00'
        opportunity_id:
          type: integer
          example: 16769
        id:
          type: integer
          description: The ID of the option.
          example: 15633
        rate:
          description: The rate offered to the shipper in USD
          type: number
          example: 3329.64
        notes:
          description: See the Notes object for more details
          type: object
    organization_user_request_object:
      description: Organization user object
      type: object
      required:
      - first_name
      - last_name
      - email
      - phone
      - password
      properties:
        first_name:
          description: First name of the organization user.
          type: string
          example: John
        last_name:
          description: Last name of the organization user.
          type: string
          example: Williams
        email:
          description: Organization user's contact email id.
          type: string
          format: email
          example: john.williams@abc.com
        phone:
          description: Organization user's contact phone number.
          $ref: '#/components/schemas/phone_request_object'
        password:
          description: Organization user's password. It must contain at least 8 characters that includes at least 1 lowercase
            character(a-z), 1 uppercase character(A-Z) and 1 number(0-9).
          type: string
          example: Secret123
    organization_user_response_object:
      description: Organization user object
      type: object
      properties:
        user_id:
          description: User Identifier.
          type: integer
          example: 12
        role:
          description: User role.
          type: string
          enum:
          - OrganizationAdmin
          - OrganizationOperation
        first_name:
          description: First name of the organization user.
          type: string
          example: John
        last_name:
          description: Last name of the organization user.
          type: string
          example: Williams
        email:
          description: Organization user's contact email id.
          type: string
          format: email
          example: john.williams@abc.com
        phone:
          description: Organization user's contact phone number.
          $ref: '#/components/schemas/phone_response_object'
    phone_request_object:
      description: Phone Object
      type: object
      required:
      - number
      properties:
        number:
          description: The 10 digit phone number.
          type: string
          example: '1234567890'
        extension_number:
          description: The extension number, supports up to 5 digits.
          type: string
          example: '1234'
    phone_response_object:
      description: Phone Object
      type: object
      properties:
        number:
          description: The 10 digit phone number.
          type: string
          example: '1234567890'
        extension_number:
          description: The extension number, supports up to 5 digits.
          type: string
          example: '1234'
    reference_type_object:
      description: Reference type Object.
      type: object
      properties:
        type_id:
          description: The type of reference. See the Option Type Object for more details
          type: string
          example: TypeId
        value:
          description: The value provided for the reference
          type: string
        created_by_user_id:
          description: The Id of the user that created the entity
          type: integer
          example: 551
        modified_by_user_id:
          type: integer
          example: 433
        created_date:
          type: string
          example: '2021-09-21T16:17:31.8333705+00:00'
        modified_date:
          type: string
          example: '2021-09-21T16:17:49.5156372+00:00'
        opportunity_id:
          type: integer
          example: 16769
        id:
          type: integer
          description: The ID of the reference.
          example: 15633
    shipment_object:
      description: Shipment Object.
      type: object
      properties:
        reference:
          description: The reference
          type: string
          example: reference
        status_id:
          description: The shipment status value
          type: integer
        opportunity:
          description: The opportunity data
          type: object
        tenders:
          type: object
        current_tender:
          type: object
        id:
          type: integer
          description: The ID of the shipment.
          example: 15633
    tenders_object:
      type: object
      properties:
        assigned_user_id:
          description: The Id of the user that is assigned to this object within the Emerge system. //Emerge is removing this
            as a required value, it will default to the authenticated user//
          type: integer
          example: 34
        id:
          description: The Emerge Id associated with the entity
          type: integer
          example: 43
        length_of_haul:
          description: The length of haul of the shipment in miles
          type: integer
          example: 766
        created_date:
          description: The date/time the entity was created
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        modified_date:
          description: The date/time the entity was updated
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        reference:
          description: The date/time the assignment
          type: string
          example: '433333'
        status_id:
          description: The opportunity status type for more details.
          type: string
          example: open
        is_deleted:
          description: A flag to identify if a tender has been deleted
          type: boolean
          example: false
        is_dispatched:
          description: A flag to identify if the tender has been dispatched (LTL only)
          type: boolean
          example: false
        assigned_user:
          description: The assigned users details. See the assigned user object for more details
          type: object
        partner_id:
          description: The Id of the partner in the emerge system
          type: integer
          example: 345
        shipment_id:
          description: The Id of the shipment associated with this object
          type: integer
          example: 8758
        rate:
          description: The total rate that will be charged to the shipper by the provider. For marketplace transactions please
            pass option_id
          type: number
          example: 345.78
        created_by_user_id:
          description: The created user identifier
          type: integer
          example: 12
        modified_by_user_id:
          description: The modified user identifier
          type: integer
          example: 12
        assignment:
          description: Assignment data
          type: object
        acceptance_date:
          description: The modified user identifier
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        documents:
          description: Documents associated with the tender. See the Documents object for more details
          type: object
        opportunity_id:
          description: The emerge opportunity objects unique identifier
          type: integer
          example: 4333
        load_type_id:
          $ref: '#/components/schemas/load_type_id_object'
        equipment_type_id:
          $ref: '#/components/schemas/equipment_type_id_object'
        equipment_size:
          $ref: '#/components/schemas/equipment_size_object'
        is_hot_load:
          description: Identifies if the load is hot.
          type: boolean
          default: false
        is_tracking_required:
          description: Defines if tracking is required on this opportunity.
          type: boolean
          default: false
        stops:
          $ref: '#/components/schemas/stops_object'
        commodities:
          $ref: '#/components/schemas/commodities_object'
        accessorials:
          $ref: '#/components/schemas/accessorials_object'
        references:
          $ref: '#/components/schemas/references_object'
        notes:
          $ref: '#/components/schemas/notes_object'
        tags:
          $ref: '#/components/schemas/tags_object'
        option_id:
          description: The ID of the option that is to be tendered against.
          type: integer
          example: 323324
          minimum: 1
    tender_stops_schedulle_object:
      description: tender Stops Schedule Object.
      type: object
      properties:
        date:
          description: The stop date, local to the stop. Supports yyyy-mm-dd format.
          type: string
          example: '2021-10-06'
        start_time:
          description: The earliest time the load is available, local to the stop. Supports format hh:mm:ss
          type: string
          example: '14:00:00'
        end_time:
          description: The earliest time the load is available, local to the stop. Supports format hh:mm:ss
          type: string
          example: '20:00:00'
    tender_stops_contact_object:
      description: Opportunity Stops Contact Object.
      type: object
      properties:
        name:
          description: The contact name for the stop
          type: string
          example: name
        phone:
          description: The phone number for the contact
          $ref: '#/components/schemas/phone_response_object'
        email:
          description: The email for the contact
          type: string
          format: email
          example: example@emergetms.com
    tender_commodity_object:
      description: A description of the items to be carried by the capacity provider.
      type: array
      items:
        type: object
        required:
        - name
        - weight
        properties:
          name:
            description: The name and description of the commodity.
            type: string
            example: FAK
          weight:
            description: The weight of the commodity in lbs.
            type: integer
            example: 44000
          quantity_unit_id:
            description: The type of unit the commodity is moved on.
            type: string
            enum:
            - Other
            - Pallet
            - Box
            - Crate
            - Bag
            - Coils
            - Drums
            - Reels
            - Rolls
            - TubesOrPipes
            - Slipsheets
            - Bale
            - Bucket
            - Bundle
            - Can
            - Carton
            - Case
            - Cylinder
            - Pail
            - Pieces
            - Skid
            example: Other
          unit_count:
            description: The unit count of the commodity.
            type: integer
            example: 2
          piece_count:
            description: The piece count of the commodity.
            type: integer
            example: 24
          length:
            description: The length of the commodity.
            type: integer
            example: 48
          width:
            description: The width of the commodity.
            type: integer
            example: 40
          height:
            description: The height of the commodity.
            type: integer
            example: 60
          is_stackable:
            description: Flag identifying a stackable commodity. Default value is false.
            type: boolean
            default: false
            example: false
          is_hazmat:
            description: Flag identifying a stackable commodity. Default value is false.
            type: boolean
            default: true
          hazmat:
            type: object
            properties:
              identification_number:
                description: The hazmat identification number for the dangerous substances.
                type: string
                example: UN1000
              packing_group_id:
                description: The packing group identifier for the hazmat load.
                enum:
                - High
                - Moderate
                - Low
                - None
                type: string
                example: High
              class_id:
                description: The class of the hazmat load
                enum:
                - MassExplosiveHazard
                - ProjectionHazard
                - MassFireHazard
                - MinorExplosionHazard
                - VeryInsensitiveExplosives
                - ExtremelyInsensitiveExplosives
                - FlammableGases
                - NonFlammableGases
                - PoisonousOrToxic
                - CombustibleLiquids
                - FlammableSolid
                - SpontaneouslyCombustibleMaterial
                - DangerousWhenWet
                - Oxidizer
                - OrganicPeroxide
                - PoisonousOrToxicMaterial
                - InfectiousSubstance
                - RadioactiveMaterial
                - Corrosives
                - MiscellaneousDangerousGoods
                type: string
                example: ExtremelyInsensitiveExplosives
              emergency_contact:
                description: The person to be contacted regarding an emergency with this Hazmat load.
                type: object
                properties:
                  name:
                    description: The name of the contact responsible for the hazmat load.
                    type: string
                    example: Adam Jacob
                  phone:
                    description: The phone number of the emergency contact.
                    $ref: '#/components/schemas/phone_response_object'
    tender_stop_object:
      description: The stops associated with the tender. A tender must have at least two stops.
      type: array
      items:
        type: object
        required:
        - order
        - name
        - address1
        - address2
        - city
        - state
        - country
        properties:
          type_id:
            description: The type of the stop.
            type: string
            enum:
            - Origin
            - Middle
            - Destination
          appointment_type_id:
            description: The appointment type for the stop.
            type: string
            enum:
            - FCFS
            - Appointment
          address1:
            description: The Address1 line for the stop.
            type: string
            example: 3665 North Harbor Drive
          address2:
            description: The Address2 line for the stop.
            type: string
          city:
            description: The city for the stop.
            type: string
            example: San Diego
          contact:
            type: object
            properties:
              name:
                description: The contact name for the person at the stop.
                type: string
                example: shipper
              phone:
                description: The phone number for the contact at the stop.
                $ref: '#/components/schemas/phone_response_object'
              email:
                type: string
                format: email
                example: shipper@stonelogistics.com
          country:
            description: The country for the stop. Use abbreviation US/USA for United States of America and CA/CAN for Canada.
            type: string
            example: US
          state:
            description: The state for the stop. Use abbreviation.
            type: string
            example: CA
          postal_code:
            description: The postal code for the stop.
            type: string
            example: '80302'
          latitude:
            description: The latitude for the stop (use decimal representation)
            type: number
            example: 32.2333
          longitude:
            description: The longitude for the stop (use decimal representation)
            type: number
            example: -104.23233
          name:
            description: the name for the stop.
            type: string
            example: Stone Brewing
          note:
            description: Notes associated with the stop.
            type: string
            example: Check in with security prior to loading or unloading.
          order:
            description: The order of the stop-starting with 1.
            type: integer
            example: 1
          action_type_id:
            description: The stop action type.
            type: string
            enum:
            - Pick
            - Drop
            example: Pick
          schedule:
            description: The schedule associated with the stop.
            type: object
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
          raw_address:
            description: A string version of the full address for the stop.
            type: string
            example: 23, Phoenix
          is_schedule_required:
            description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf. Not recommended
              for the marketplace workflow
            type: boolean
            example: true
    webhook_object:
      type: object
      description: Details of the webhook.
      properties:
        authentication:
          description: Determines the authentication type for the webhook
          type: object
          properties:
            is_enabled:
              description: Authentication user status .
              type: boolean
              example: true
            username:
              description: Authentication username.
              type: string
              example: username
            password:
              description: Authentication password.
              type: string
              example: password
        content_type:
          description: Request content type.
          type: string
          example: application/json
        event_types:
          description: Event types of webhook.
          type: array
          items:
            $ref: '#/components/schemas/webhook_event_types'
        is_enabled:
          description: Status of the webhook.
          type: boolean
          example: true
        url:
          description: Webhook url of the account.
          type: string
          example: webhook_url
        created_date:
          description: The date/time the entity was created
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
        modified_date:
          description: The date/time the entity was updated
          type: string
          example: '2019-02-12T02:36:54.2973188+00:00'
    webhook_authentication_object:
      type: object
      description: Details of the webhook webhook_authentication_object.
      properties:
        authentication:
          description: Determines the authentication type for the webhook
          type: object
          properties:
            is_enabled:
              description: Authentication user status .
              type: boolean
              example: true
            username:
              description: The username used for authentication
              type: string
              example: username
            password:
              description: The password to be used for authentication
              type: string
              example: password
    opportunity_status:
      description: The Opportunity status.
      type: integer
      enum:
      - Open: 1
      - Closed: 2
      example: 1
    opportunity_type:
      description: The Opportunity type.
      type: integer
      enum:
      - Quote: 1
      example: 1
    shipment_status:
      description: The Shipment status.
      type: integer
      enum:
      - Open: 1
      - Tendered: 2
      - Closed: 3
      - Canceled: 4
      - Covered: 5
      example: 1
    tender_document:
      description: Documents associated with the tender. See the Documents object for more details
      type: object
      properties:
        tender_document_type_id:
          description: Document type for the tender.
          type: string
          enum:
          - Other: 1
          - ProofOfDelivery: 2
          - BillOfLading: 3
          - RateConfirmation: 4
          - Invoice: 5
          - TransportationDocuments: 6
          - SignedRateConfirmation: 7
          example: 2
        id:
          description: Document Id for the tender.
          type: integer
          example: 42734
        file_name:
          description: The file name for the tender.
          type: string
          example: Emerge-public-api11
        file_extension:
          description: The file extension for the tender.
          type: string
          example: yaml
        content_type:
          description: The content type for the tender.
          type: string
          example: application/octet-stream
        size:
          description: The file size for the tender.
          type: number
          example: 317119
        url:
          description: The file url for the tender.
          type: string
          example: null
        document_type_id:
          description: The document type id for the tender.
          type: string
          enum:
          - Internal: 1
          - Integration: 2
          example: 1
    transportation_entity_types:
      description: Transportation entity types.
      type: string
      enum:
      - Other
      - Broker
      - Carrier
      - CarrierOrBroker
      example: CarrierOrBroker
    tender_status:
      description: The tender status.
      type: string
      enum:
      - Undefined: 0
      - New: 1
      - Accepted: 2
      - Rejected: 3
      - Canceled: 4
      example: 1
    webhook_stops_object:
      description: The stops associated with the opportunity. An opportunity must have at least two stops.
      type: array
      items:
        type: object
        properties:
          id:
            description: Id for the stop..
            type: integer
            example: 3241
          type_id:
            description: The type for the stop.
            type: string
            enum:
            - Origin: 1
            - Middle: 2
            - Destination: 3
            example: 1
          name:
            description: the Name for the stop.
            type: string
            example: Stone Brewing Company
          action_type_id:
            description: The action type for the stop.
            type: string
            enum:
            - Pick: 1
            - Drop: 2
            example: 1
          sequence:
            description: The stop sequence.
            type: integer
            example: 1
          contact:
            type: object
            properties:
              name:
                description: The contact name for the person at the stop.
                type: string
                example: Shipper
              phone:
                description: The phone number for the contact at the stop.
                $ref: '#/components/schemas/phone_response_object'
              email:
                type: string
                example: shipper@stonelogistics.com
          is_schedule_required:
            description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf. Not recommended
              for the marketplace workflow.
            type: boolean
            example: false
          schedule:
            description: The schedule associated with the stop.
            type: object
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_date:
                description: The start date identifier.
                type: string
                example: 22020-10-06
              end_date:
                description: The end date identifier.
                type: string
                example: '2020-10-08'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
              time_zone:
                description: The time zone identifier.
                type: string
                example: '-7'
              time_zone_name:
                description: The time zone name identifier.
                type: string
                example: America/Los_Angeles
              ms_time_zone_name:
                description: The Mstime zone name identifier.
                type: string
                example: Pacific Standard Time
          appointment_schedule:
            description: The ppointment schedule associated with the stop.
            type: object
            properties:
              date:
                description: The date associated with the stop. Supports yyyy-mm-dd format.
                type: string
                example: '2021-10-06'
              start_date:
                description: The start date identifier.
                type: string
                example: 22020-10-06
              end_date:
                description: The end date identifier.
                type: string
                example: '2020-10-08'
              start_time:
                description: Based upon the local time at the stop, the earliest time the load is available. Supports the
                  format hh:mm:ss
                type: string
                example: '14:00:00'
              end_time:
                description: Based upon the local time at the stop, the last time the load is available. Supports the format
                  hh:mm:ss
                type: string
                example: '20:00:00'
              time_zone:
                description: The time zone identifier.
                type: string
                example: '-7'
              time_zone_name:
                description: The time zone name identifier.
                type: string
                example: America/Los_Angeles
              ms_time_zone_name:
                description: The Mstime zone name identifier.
                type: string
                example: Pacific Standard Time
          address1:
            description: The Address1 line for the stop.
            type: string
            example: 3665 North Harbor Drive
          address2:
            description: The Addres2 line for the stop.
            type: string
            example: string
          city:
            description: The city for the stop.
            type: string
            example: San Diego
          country:
            description: The country for the stop. Use abbreviation.
            type: string
            example: US
          state:
            description: The state of the stop. Use abbreviation.
            type: string
            example: CA
          postal_code:
            type: string
            example: '92101'
          latitude:
            description: The latitude for the stop (use Decimal Degrees form).
            type: number
            example: 32.7325
          longitude:
            description: The longitude for the stop (use Decimal Degrees form).
            type: number
            example: -117.2011
          appointment_type_id:
            description: The appointment type for the stop.
            type: string
            enum:
            - FCFS: 1
            - Appointment: 2
            example: 1
          note:
            description: Notes associated with the stop.
            type: string
            example: Check in with security prior to loading or unloading.
          AddressBookLocationId:
            description: The Address Book Location Id.
            type: integer
            example: 1
    webhook_event_types:
      description: Webhook event types.
      type: string
      enum:
      - '*'
      - tracking_status_updated
      - delivery_status_updated
      - stop_actual_times_updated
      - current_location_updated_job
      - current_marketplace_option
      - opportunity_awarded
      - options_changed
      - tender_status_updated
      - network_partner_updated
      - network_partner_deleted
      - opportunity_deleted
      - opportunity_not_awarded
      example: tracking_status_updated
    delivery_Status:
      description: The delivery status of the shipment.
      type: string
      enum:
      - Unknown: 1
      - OnTime: 2
      - InJeopardy: 3
      - Late: 4
      - Early: 5
      - TrackingLost: 6
      - AtRisk: 7
      example: 2
    tracking_shipment_object:
      type: object
      properties:
        id:
          description: The id for the shipment.
          type: integer
          example: 7298
        emerge_reference:
          description: The emerge reference for the shipment.
          type: string
          example: S11007298
        status_id:
          $ref: '#/components/schemas/shipment_status'
        opportunity_id:
          description: The opportunity id for the shipment.
          type: integer
          example: 7353
        organization_id:
          description: The organization id for the shipment.
          type: integer
          example: 336
        public_tracking_link:
          description: This feature is limited to ProcureOS Pro plans
          type: string
          example: https://app.emergemarket.io/en/publictracking/12345
        tender:
          description: The tender associated with the shipment.
          type: object
          properties:
            id:
              description: The Emerge Id associated with the entity
              type: integer
              example: 1868
            status_id:
              description: The opportunity status type for more details.
              $ref: '#/components/schemas/tender_status'
            load_type_id:
              $ref: '#/components/schemas/load_type_id_object'
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            equipment_size:
              $ref: '#/components/schemas/equipment_size_object'
            length_of_haul:
              description: The length of haul of the shipment in miles
              type: integer
              example: 1083
            rate:
              description: The rate for the shipment in USD.
              type: number
              example: 190.12
            rate_per_mile:
              description: The rate for the shipment per mile in USD.
              type: number
              example: 1.75
            Customer:
              description: The Customer identifier.
              type: string
            partner:
              description: Details of the partner associated with the tender.
              type: object
              properties:
                id:
                  description: Emerge system's identifier of the winning partner.
                  type: integer
                  example: 473
                first_name:
                  description: Network partner's first name.
                  type: string
                  example: mycarrier
                last_name:
                  description: Network partner's last name.
                  type: string
                  example: test
                email:
                  description: Network partner contact's email id.
                  type: string
                  format: email
                  example: mycarrier.test@abc.com
                code:
                  description: Network partner contact's code.
                  type: string
                  example: AS1234
            commodities:
              $ref: '#/components/schemas/webhook_commodities_object'
            stops:
              $ref: '#/components/schemas/webhook_stops_object'
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            references:
              $ref: '#/components/schemas/references_object'
            notes:
              type: array
              items:
                description: This shipment is ready to go now. Please provide your best options.
                properties:
                  note:
                    description: The specific note for the tender.
                    type: string
            tags:
              $ref: '#/components/schemas/tags_object'
            documents:
              $ref: '#/components/schemas/tender_document'
            assignment:
              description: Assignment data associated with the tender.
              type: object
              properties:
                id:
                  description: Id of the assignment.
                  type: integer
                  example: 1086
                license_plate_number:
                  description: The license plate number of the assignment.
                  type: string
                  example: ABC111408
                last_position_event:
                  type: object
                  properties:
                    address1:
                      description: The address 1 of the stop.
                      type: string
                      example: 3665 North
                    address2:
                      description: The address 2 of the stop.
                      type: string
                      example: Harbor Drive
                    city:
                      description: The city of the stop.
                      type: string
                      example: San Diego
                    state:
                      description: The state of the stop.
                      type: string
                      example: CA
                    postal_code:
                      description: The postal code of the stop.
                      type: string
                      example: '92101'
                    country:
                      description: The Country of the stop.
                      type: string
                      example: US
                    latitude:
                      description: Latitude of the stop (in decimal representation)
                      type: number
                      example: 32.7325
                    longitude:
                      description: Longitude of the stop (in decimal representation)
                      type: number
                      example: -117.2011
                stops:
                  type: array
                  items:
                    type: object
                    properties:
                      actual_arrival:
                        description: The date/time of actual arrival. This is a Date time offset.
                        type: string
                        example: '2019-07-12T02:36:54.2973188+00:00'
                      actual_departure:
                        description: The date/time of actual departure. This is a Date time offset.
                        type: string
                        example: '2019-07-14T02:36:54.2973188+00:00'
                      estimated_delivery_date:
                        description: The date/time of estimated delivery. This is a Date time offset.
                        type: string
                        example: '2019-07-15T02:36:54.2973188+00:00'
                      delivery_status_id:
                        $ref: '#/components/schemas/delivery_Status'
                      is_active_stop:
                        description: Flag identifying a stop is active.
                        type: boolean
                        example: true
                      tender_stop_id:
                        description: The tender stop id of the stop.
                        type: integer
                        example: 3773
                      sequence:
                        description: The sequence number of the stop.
                        type: integer
                        example: 1
                tracking_status_id:
                  description: The Tracking status value.
                  type: string
                  enum:
                  - TenderAccepted: 1
                  - Dispatched: 4
                  - InTransit: 5
                  - Delivered: 6
                  - Completed: 8
                  - Canceled: 9
                  - AtShipper: 10
                  - AtConsignee: 11
                  example: 1
                last_status_update:
                  description: The date/time in which the status update occurred. This is a Date time offset.
                  type: string
                  example: '2019-07-17T12:37:04.5697743+00:00'
                delivery_status_id:
                  $ref: '#/components/schemas/delivery_Status'
                driver_phone:
                  description: Driver contact's phone number.
                  $ref: '#/components/schemas/phone_response_object'
                created_date:
                  description: The date/time the entity was created. This is a date/time offset.
                  type: string
                  example: '2019-02-12T02:36:54.2973188+00:00'
                modified_date:
                  description: The date/time the entity was updated. This is a date/time offset.
                  type: string
                  example: '2019-02-12T02:36:54.2973188+00:00'
                created_by_user_id:
                  description: The created user identifier
                  type: integer
                  example: 1300188
                modified_by_user_id:
                  description: The modified user identifier.
                  type: integer
                  example: 1300188
                is_driver_phone_hidden:
                  description: Is Driver Phone Hidden of the assignment.
                  type: boolean
                  example: false
            asigned_user:
              description: The assigned users details.
              type: object
              properties:
                id:
                  description: Id of the asigned user.
                  type: integer
                  example: 1300188
                first_name:
                  description: First name of the asigned user.
                  type: string
                  example: Kyle
                last_name:
                  description: Last name of the asigned user.
                  type: string
                  example: Newman
            acceptance_date:
              description: The date/time modified user identifier. This is a date/time offset.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
            created_date:
              description: The date/time the entity was created. This is a date/time offset.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
            modified_date:
              description: The date/time the entity was updated. This is a date/time offset.
              type: string
              example: '2019-02-12T02:36:54.2973188+00:00'
            created_by_user_id:
              description: The created user identifier.
              type: integer
              example: 1300188
            modified_by_user_id:
              description: The modified user identifier.
              type: integer
              example: 1300188
            is_dispatched:
              description: A flag to identify if the tender has been dispatched (LTL only)
              type: boolean
              example: false
            is_tracking_required:
              description: A flag to identify if tracking required.
              type: boolean
              example: false
            is_hot_load:
              description: A flag to identify if hot load enabled.
              type: boolean
              example: false
        notes:
          type: array
          items:
            description: This shipment is ready to go now. Please provide your best options.
            properties:
              note:
                description: The specific note for the shipment.
                type: string
    webhook_commodities_object:
      description: A description of the items to be carried by the capacity provider.
      type: array
      items:
        type: object
        properties:
          id:
            description: The commodity identifier.
            type: integer
            default: 0
          description:
            description: The name and description of the commodity.
            type: string
            example: FAK
          weight:
            description: The weight of the commodity in lbs.
            type: integer
            example: 100
          Nmfc:
            description: The Nmfc of the commodity.
            type: string
          freight_class_id:
            description: The freight class id of the commodity.
            type: string
            enum:
            - FiftyFive: 1
            - Sixty: 2
            - SixtyFive: 3
            - Seventy: 4
            - SeventySevenDotFive: 5
            - EightyFive: 6
            - NinetyTwoDotFive: 7
            - OneHundred: 8
            - OneHundredTen: 9
            - OneHundredTwentyFive: 10
            - OneHundredFifty: 11
            - OneHundredSeventyFive: 12
            - TwoHundreds: 13
            - TwoHundredsFifty: 14
            - ThreeHundreds: 15
            - FourHundreds: 16
            - FiveHundreds: 17
            - Fifty: 18
            example: 2
          unit_count:
            description: The unit count of the commodity.
            type: integer
            example: 10
          piece_count:
            description: The piece count of the commodity.
            type: integer
            example: 11
          length:
            description: The length of the commodity.
            type: integer
            example: 10
          width:
            description: The width of the commodity.
            type: integer
            example: 11
          height:
            description: The height of the commodity.
            type: integer
            example: 12
          unit_type_id:
            description: The type of unit the commodity is moved on.
            type: string
            enum:
            - Other: 0
            - Pallet: 1
            - Box: 2
            - Crate: 3
            - Bag: 4
            - Coils: 5
            - Drums: 6
            - Reels: 7
            - Rolls: 8
            - TubesOrPipes: 9
            - Slipsheets: 10
            - Bale: 11
            - Bucket: 12
            - Bundle: 13
            - Can: 14
            - Carton: 15
            - Case: 16
            - Cylinder: 17
            - Pail: 18
            - Pieces: 19
            - Skid: 20
            example: 1
          is_stackable:
            description: Flag identifying a stackable commodity. Default value is false.
            type: boolean
            default: false
            example: false
          is_hazmat:
            description: Flag identifying a hazmat commodity. Default value is false.
            type: boolean
            default: false
            example: true
          hazmat:
            type: object
            properties:
              identification_number:
                description: The hazmat identification number for the dangerous substances.
                type: string
                example: UN1000
              packing_group_id:
                description: The packing group identifier for the hazmat load.
                enum:
                - High: 1
                - Moderate: 2
                - Low: 3
                - None: 4
                type: string
                example: 1
              class_id:
                description: The class of the hazmat load.
                enum:
                - MassExplosiveHazard: 1
                - ProjectionHazard: 2
                - MassFireHazard: 3
                - MinorExplosionHazard: 4
                - VeryInsensitiveExplosives: 5
                - ExtremelyInsensitiveExplosives: 6
                - FlammableGases: 7
                - NonFlammableGases: 8
                - PoisonousOrToxic: 9
                - CombustibleLiquids: 10
                - FlammableSolid: 11
                - SpontaneouslyCombustibleMaterial: 12
                - DangerousWhenWet: 13
                - Oxidizer: 14
                - OrganicPeroxide: 15
                - PoisonousOrToxicMaterial: 16
                - InfectiousSubstance: 17
                - RadioactiveMaterial: 18
                - Corrosives: 19
                - MiscellaneousDangerousGoods: 20
                type: string
                example: 6
              emergency_contact:
                description: The person to be contacted regarding an emergency with this Hazmat load.
                type: object
                properties:
                  name:
                    description: The name of the contact responsible for the hazmat load.
                    type: string
                    example: Kyle Jepsen
                  phone:
                    description: The phone number of the emergency contact.
                    $ref: '#/components/schemas/phone_response_object'
    Opportunity_Awarded_Event:
      type: object
      description: This object contains details of the Awarded option, so that the subscriber can do the subsequent actions,
        including tendering to it, in their own TMS.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: 60e6d639-5f61-4a0b-b563-cf4d92cec2cc
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2019-07-17T12:45:11.5130697+00:00'
        event_type:
          description: The event type name.
          type: string
          example: opportunity_awarded
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            award_id:
              description: Emerge system identifier of the Award object.
              type: integer
              example: 23423
            opportunity_id:
              description: Emerge system identifier for the awarded opportunity.
              type: integer
              example: 3453534
            option_id:
              description: Emerge system identifier of the winning option.
              type: integer
              example: 234234
            partner_quote_reference:
              description: Quote reference number of the winning partner.
              type: string
              example: '234234'
            expiration_date:
              description: Expiration date of the winning option.
              type: string
              example: '2020-10-28T07:53:59.402Z'
            availability_date:
              description: Availability date of the winning option.
              type: string
              example: '2020-10-28T07:53:59.402Z'
            partner:
              description: Details of the transportation entity associated with the winning partner
              type: object
              properties:
                id:
                  description: Emerge system's identifier of the winning partner.
                  type: integer
                  example: 42342
                partner_code:
                  description: Partner code of the winning partner as assigned by shipment provider.
                  type: string
                  example: AS1234
                transportation_entity:
                  description: Details of the transportation entity associated with the winning partner.
                  type: object
                  properties:
                    id:
                      description: Emerge system's identifier of the transportation entity.
                      type: integer
                      example: 32424
                    legal_name:
                      description: Transportation entity legal name.
                      type: string
                      example: My Carrier Logistic
                    dba_name:
                      description: Transportation entity dba name.
                      type: string
                      example: '2894801'
                    dot_number:
                      description: Transportation entity DOT number.
                      type: integer
                      example: 938147
                    docket_number:
                      description: Transportation entity Docket number.
                      type: string
                      example: MC456244
                    type:
                      description: Network partner's type.
                      type: string
                      example: Broker
                contact:
                  description: Contact information of the winning partner.
                  type: object
                  properties:
                    first_name:
                      description: First name of the contact.
                      type: string
                      example: mycarrier
                    last_name:
                      description: Last name of the contact.
                      type: string
                      example: test
                    contact_email:
                      description: Email of the contact.
                      type: string
                      format: email
                      example: mycarrier.test@abc.com
                    contact_phone_number:
                      description: Phone number of the contact.
                      type: string
                      example: '1234567890'
                    contact_extension_number:
                      description: Phone number extension of the contact.
                      type: string
                      example: '1234'
            rate:
              description: Rate of the winning option in USD.
              type: number
              example: 300.5
            rate_details:
              description: Rate details of the winning option.
              type: object
              properties:
                line_haul:
                  description: The line haul rate. Populates when is_total_rate is false.
                  type: number
                  example: 400.01
                estimated_line_haul:
                  description: The estimated line haul rate. Populates when is_total_rate is true.
                  type: number
                  example: 200.23
                estimated_fuel:
                  description: The estimated fuel rate.
                  type: number
                  example: 100
            is_total_rate:
              description: Indicates whether the rate contains fuel surcharge or not.
              type: boolean
              example: true
            modified_date:
              description: Modified date of the winning option.
              type: string
              example: '2020-10-28T07:53:59.403Z'
            created_date:
              description: Created date of the winning option.
              type: string
              example: '2020-10-28T07:53:59.403Z'
            notes:
              description: Notes on the award.
              type: string
              example: Awarded to lowest option
            emerge_opportunity_reference:
              description: Emerge reference for the awarded opportunity.
              type: string
              example: Q113453534
            references:
              $ref: '#/components/schemas/references_object'
            award_method:
              description: Award method for the awarded opportunity.
              type: string
              enum:
              - Manual
              - AutoAward
              - BookItNow
              example: Manual
    Options_Changed_Event:
      type: object
      description: This object contains the list of all the options available for a particular opportunity. Showing all options
        or the lowest option can be controlled in the application setting. Whenever there is a change in the available option(s),
        this event will get triggered and notify the consumer.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: c8d20000-9bf2-98fa-79b6-08d895e1800b
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2020-12-01T10:11:42.1339822+00:00'
        event_type:
          description: The event type name
          type: string
          example: options_changed
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            opportunity_id:
              description: Emerge system identifier for the opportunity.
              type: integer
              example: 1047
            references:
              $ref: '#/components/schemas/references_object'
            options:
              description: This data object contains all the details associated with the event.
              type: array
              items:
                type: object
                properties:
                  opportunity_id:
                    deprecated: true
                    description: Emerge system identifier for the opportunity.
                    type: integer
                    example: 1047
                  option_id:
                    description: Emerge system identifier of the option.
                    type: integer
                    example: 68
                  partner_quote_reference:
                    description: Quote reference number of the partner.
                    type: string
                    example: 2
                  expiration_date:
                    description: Expiration date of the option.
                    type: string
                    example: '2020-10-28T07:53:59.402Z'
                  availability_date:
                    description: Availability date of the option.
                    type: string
                    example: '2020-10-28T07:53:59.402Z'
                  partner:
                    description: Details of the partner.
                    type: object
                    properties:
                      id:
                        description: Emerge system's identifier of the winning partner.
                        type: integer
                        example: 1
                      partner_code:
                        description: Partner code of the winning partner as assigned by shipment provider.
                        type: string
                        example: AS1234
                      transportation_entity:
                        description: Details of the transportation entity associated with the winning partner.
                        type: object
                        properties:
                          id:
                            description: Emerge system's identifier of the transportation entity.
                            type: integer
                            example: 230962
                          legal_name:
                            description: Transportation entity legal name.
                            type: string
                            example: My Carrier Logistic
                          dba_name:
                            description: Transportation entity dba name.
                            type: string
                            example: '2894801'
                          dot_number:
                            description: Transportation entity DOT number.
                            type: integer
                            example: 2877224
                          docket_number:
                            description: Transportation entity Docket number.
                            type: string
                            example: MC965703
                          type:
                            description: Transportation entity type.
                            type: string
                            example: Broker
                      contact:
                        description: Contact information of the winning partner.
                        type: object
                        properties:
                          first_name:
                            description: First name of the contact.
                            type: string
                            example: mycarrier
                          last_name:
                            description: Last name of the contact.
                            type: string
                            example: test
                          contact_email:
                            description: Email of the contact.
                            type: string
                            format: email
                            example: mycarrier.test@abc.com
                          contact_phone_number:
                            description: Phone number of the contact.
                            type: string
                            example: '1234567890'
                          contact_extension_number:
                            description: Phone number extension of the contact.
                            type: string
                            example: '1234'
                  rate:
                    description: Rate of the option.
                    type: number
                    example: 300.23
                  is_total_rate:
                    description: Indicates whether the rate contains fuel surcharge or not.
                    type: boolean
                    example: true
                  rate_details:
                    description: Rate details of the option.
                    type: object
                    properties:
                      line_haul:
                        description: The line haul rate. Populates when is_total_rate is false.
                        type: number
                        example: 400.01
                      estimated_line_haul:
                        description: The estimated line haul rate. Populates when is_total_rate is true.
                        type: number
                        example: 200.23
                      estimated_fuel:
                        description: The estimated fuel rate.
                        type: number
                        example: 100
                  modified_date:
                    description: Modified date of the option.
                    type: string
                    example: '2020-10-28T07:53:59.403Z'
                  created_date:
                    description: Created date of the option.
                    type: string
                    example: '2020-10-28T07:53:59.403Z'
                  notes:
                    description: The award note.
                    type: string
                  references:
                    $ref: '#/components/schemas/references_object'
                  option_submission_type:
                    description: Submission type of the option.
                    type: string
                    enum:
                    - Offer
                    - BookItNow
                    - Contract
                    example: Offer
    Tender_Status_Updated_Event:
      type: object
      description: Details of the Partner Updated_Event.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: d6400000-9bf2-98fa-1e1b-08d904ca6a9b
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-04-21T13:36:06.8089396+00:00'
        event_type:
          description: The event type name
          type: string
          example: tender_status_updated
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            new_state:
              type: object
              properties:
                tender_status_id:
                  description: The tender status value, the following values are supported.
                  $ref: '#/components/schemas/tender_status'
            old_state:
              type: object
              properties:
                tender_status_id:
                  description: The tender status value, the following values are supported.
                  $ref: '#/components/schemas/tender_status'
        tender:
          type: object
          properties:
            assigned_user_id:
              description: The assigned user id of the tender.
              type: integer
              example: 70018
            partner_id:
              description: The partner id of the tender.
              type: integer
              example: 4
            shipment_id:
              description: The shipment id of the tender.
              type: integer
              example: 3355
            shipment_status_id:
              $ref: '#/components/schemas/shipment_status'
            load_type_id:
              $ref: '#/components/schemas/load_type_id_object'
            equipment_type_id:
              $ref: '#/components/schemas/equipment_type_id_object'
            freight_provider_organization_equipment_type_id:
              description: The freight provider organization equipment type id of the tender.
              type: integer
              example: 230
            freight_provider_organization_equipment_type_name:
              $ref: '#/components/schemas/equipment_type_id_object'
            length_of_haul:
              description: The length of haul of the tender.
              type: integer
              example: 1
            length_of_haul_source_id:
              description: The source of the length of haul calculation. Enumeration.
              type: string
              enum:
              - Manual: 1
              - Google: 2
              - Alk: 3
              example: 3
            is_length_of_haul_override_enabled:
              description: Boolean to indicate if the length of haul has been overridden.
              type: boolean
              example: false
            length_of_haul_result:
              $ref: '#/components/schemas/length_of_haul_result_object'
            is_tracking_required:
              description: The tracking required identifier.
              type: boolean
              example: false
            rate:
              description: The rate for the shipment in USD.
              type: number
              example: 876.75
            rate_per_mile:
              description: The rate for the shipment per mile in USD.
              type: number
              example: 3.57
            fuel_rate:
              description: The total rate for the fuel in USD.
              type: number
              example: 6.79
            is_hot_load:
              description: The is hot load flag.
              type: boolean
              example: false
            option_id:
              description: The ID of the option associated with the tender.
              type: integer
              example: 2240
            option:
              description: The option details.
              type: object
              properties:
                id:
                  description: The ID of the option associated with the tender.
                  type: integer
                  example: 2240
                modified_date:
                  description: The modified date/time of option. This is a date/time offset.
                  type: string
                  example: '2021-09-18T20:39:20.8137938+00:00'
                type_id:
                  description: The type id of option.
                  type: string
                  enum:
                  - ManuallyCreated: 1
                  - GeneratedByLaneRate: 2
                  - Ltl: 4
                  - PostingResponse: 5
                  - TlConnect: 6
                  - TenderServiceDefault: 7
                  - PricingService: 8
                  - TenderServiceEDI: 9
                  - EdgeDefault: 10
                  example: 1
                opportunity_id:
                  description: The opportunity id of option.
                  type: integer
                  example: 3373
                partner_id:
                  description: The partner id of option.
                  type: integer
                  example: 4
                rate:
                  description: The rate of option.
                  type: number
                  example: 876
                rate_per_mile:
                  description: The rate per mile of option.
                  type: number
                  example: 3.57
                fuel_rate:
                  description: The fuel rate of option.
                  type: number
                  example: 6.79
                is_fuel_included:
                  description: The fuel included flag of option.
                  type: boolean
                  example: false
                line_haul_rate:
                  description: The line haul rate of option.
                  type: number
                  example: 869.52
                line_haul_rate_per_mile:
                  description: The line haul rate per mile of option.
                  type: number
                  example: 3.35
                notes:
                  $ref: '#/components/schemas/notes_object'
            commodities:
              $ref: '#/components/schemas/commodities_object'
            accessorials:
              $ref: '#/components/schemas/accessorials_object'
            stops:
              description: The stops associated with the opportunity. An opportunity must have at least two stops.
              type: array
              items:
                type: object
                properties:
                  id:
                    description: The id of the stop.
                    type: integer
                    example: 3241
                  raw_address:
                    description: A string version of the full address.
                    type: string
                    example: Stone Brewing Company, 3665 North Harbor Drive string, San Diego, CA, 92101, US
                  order:
                    description: The order identifier.
                    type: integer
                    example: 1
                  type_id:
                    description: The type of the stop.
                    type: string
                    enum:
                    - Origin: 1
                    - Middle: 2
                    - Destination: 3
                    example: 1
                  name:
                    description: The name for the stop.
                    type: string
                    example: Stone Brewing Company
                  action_type_id:
                    description: The stop action type.
                    type: string
                    enum:
                    - Pick: 1
                    - Drop: 2
                    example: 1
                  sequence:
                    description: The stop sequence number.
                    type: integer
                    example: 1
                  contact:
                    type: object
                    properties:
                      name:
                        description: The contact name for the person at the stop.
                        type: string
                        example: Shipper
                      phone:
                        description: The phone number for the contact at the stop.
                        $ref: '#/components/schemas/phone_response_object'
                      email:
                        type: string
                        example: shipper@stonelogistics.com
                  is_schedule_required:
                    description: Determines if a shipper will allow the carrier to schedule an appointment on their behalf.
                      Not recommended for the marketplace workflow
                    type: boolean
                    example: false
                  schedule:
                    description: The schedule associated with the stop.
                    type: object
                    properties:
                      date:
                        description: The date associated with the stop. Supports yyyy-mm-dd format.
                        type: string
                        example: '2021-10-06'
                      start_date:
                        description: The start date identifier.
                        type: string
                        example: 22020-10-06
                      end_date:
                        description: The end date identifier.
                        type: string
                        example: '2020-10-08'
                      start_time:
                        description: Based upon the local time at the stop, the earliest time the load is available. Supports
                          the format hh:mm:ss
                        type: string
                        example: '14:00:00'
                      end_time:
                        description: Based upon the local time at the stop, the last time the load is available. Supports
                          the format hh:mm:ss
                        type: string
                        example: '20:00:00'
                      time_zone:
                        description: The time zone identifier.
                        type: string
                        example: '-7'
                      time_zone_name:
                        description: The time zone name identifier.
                        type: string
                        example: America/Los_Angeles
                      ms_time_zone_name:
                        description: The Mstime zone name identifier.
                        type: string
                        example: Pacific Standard Time
                  appointment_schedule:
                    description: The ppointment schedule associated with the stop.
                    type: object
                    properties:
                      date:
                        description: The date associated with the stop. Supports yyyy-mm-dd format.
                        type: string
                        example: '2021-10-06'
                      start_date:
                        description: The start date identifier.
                        type: string
                        example: 22020-10-06
                      end_date:
                        description: The end date identifier.
                        type: string
                        example: '2020-10-08'
                      start_time:
                        description: Based upon the local time at the stop, the earliest time the load is available. Supports
                          the format hh:mm:ss
                        type: string
                        example: '14:00:00'
                      end_time:
                        description: Based upon the local time at the stop, the last time the load is available. Supports
                          the format hh:mm:ss
                        type: string
                        example: '20:00:00'
                      time_zone:
                        description: The time zone identifier.
                        type: string
                        example: '-7'
                      time_zone_name:
                        description: The time zone name identifier.
                        type: string
                        example: America/Los_Angeles
                      ms_time_zone_name:
                        description: The Mstime zone name identifier.
                        type: string
                        example: Pacific Standard Time
                  address1:
                    description: The address 1 of the stop.
                    type: string
                    example: 3665 North Harbor Drive
                  address2:
                    description: The address 2 of the stop.
                    type: string
                    example: string
                  city:
                    description: The city of the stop.
                    type: string
                    example: San Diego
                  country:
                    description: The country of the stop.
                    type: string
                    example: US
                  state:
                    description: The state of the stop.
                    type: string
                    example: CA
                  postal_code:
                    type: string
                    example: '92101'
                  latitude:
                    description: Latitude of the stop (decimal representation)
                    type: number
                    example: 32.7325
                  longitude:
                    description: Longitude of the stop (decimal representation)
                    type: number
                    example: -117.2011
                  appointment_type_id:
                    description: The appointment type.
                    type: string
                    enum:
                    - FCFS: 1
                    - Appointment: 2
                    example: 1
                  note:
                    description: Notes associated with the stop.
                    type: string
                    example: Check in with security prior to loading or unloading.
                  AddressBookLocationId:
                    description: The Address Book Location Id.
                    type: integer
                    example: 1
            references:
              $ref: '#/components/schemas/references_object'
            notes:
              $ref: '#/components/schemas/notes_object'
    Network_Partner_Updated_Event:
      type: object
      description: This object contains the partner details. Whenever there is a change in the partner details this event
        will get triggered and notify the consumer.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: b07a0000-ff1b-0003-e106-08d909433d91
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-04-27T06:11:05.4316652+00:00'
        event_type:
          description: The event type name
          type: string
          example: network_partner_updated
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            partner:
              description: This data object contains all the details associated with the event.
              type: object
              properties:
                partner_id:
                  description: The network partner identifier.
                  type: integer
                  example: 74844
                status:
                  description: Network partner status.
                  type: string
                  enum:
                  - Confirmed
                  - AwaitingConfirmation
                partner_code:
                  description: Network partner's partner code.
                  type: string
                  example: PAUP127
                type:
                  description: Network partner's type.
                  type: string
                  enum:
                  - Network
                  - Hidden
                transportation_entity:
                  type: object
                  properties:
                    company_name:
                      description: Transportation entity company name.
                      type: string
                      example: EDUARDO RODRIGUEZ GONZALEZ
                    legal_name:
                      description: Transportation entity legal name.
                      type: string
                      example: EDUARDO RODRIGUEZ GONZALEZ
                    dot_number:
                      description: Transportation entity DOT number.
                      type: integer
                      example: 1503353
                    docket_number:
                      description: Transportation entity docket number.
                      type: string
                      example: MX564565
                    address:
                      description: Transportation entity address.
                      type: object
                      properties:
                        address:
                          type: string
                          example: 'DELICIAS #5789'
                        city:
                          type: string
                          example: NUEVO LAREDO
                        state:
                          type: string
                          example: TM
                        postal_code:
                          type: integer
                          example: 88190
                contact:
                  type: object
                  properties:
                    first_name:
                      description: Network partner's first name.
                      type: string
                      example: Emerge
                    last_name:
                      description: Network partner's last name.
                      type: string
                      example: test
                    email:
                      description: Network partner contact's email id.
                      type: string
                      format: email
                      example: emergetest@emergetms.com
                    phone:
                      description: Network partner contact's phone number.
                      $ref: '#/components/schemas/phone_response_object'
                tags:
                  $ref: '#/components/schemas/tags_object'
    Network_Partner_Deleted_Event:
      type: object
      description: This object contains the partner details. Whenever a partner is deleted this event will get triggered and
        notify the consumer.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: b07a0000-ff1b-0003-e106-08d909433d91
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-04-27T06:11:05.4316652+00:00'
        event_type:
          description: The event type name
          type: string
          example: network_partner_deleted
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            partner:
              description: This data object contains all the details associated with the event.
              type: object
              properties:
                partner_id:
                  description: The network partner identifier.
                  type: integer
                  example: 74844
                status:
                  description: Network partner status.
                  type: string
                  enum:
                  - Confirmed
                  - AwaitingConfirmation
                partner_code:
                  description: Network partner's partner code.
                  type: string
                  example: PAUP127
                type:
                  description: Network partner's type.
                  type: string
                  enum:
                  - Network
                  - Hidden
                transportation_entity:
                  type: object
                  properties:
                    company_name:
                      description: Transportation entity company name.
                      type: string
                      example: EDUARDO RODRIGUEZ GONZALEZ
                    legal_name:
                      description: Transportation entity legal name.
                      type: string
                      example: EDUARDO RODRIGUEZ GONZALEZ
                    dot_number:
                      description: Transportation entity DOT number.
                      type: integer
                      example: 1503353
                    docket_number:
                      description: Transportation entity docket number.
                      type: string
                      example: MX564565
                    address:
                      description: Transportation entity address.
                      type: object
                      properties:
                        address:
                          type: string
                          example: 'DELICIAS #5789'
                        city:
                          type: string
                          example: NUEVO LAREDO
                        state:
                          type: string
                          example: TM
                        postal_code:
                          type: integer
                          example: 88190
                contact:
                  type: object
                  properties:
                    first_name:
                      description: Network partner's first name.
                      type: string
                      example: Emerge
                    last_name:
                      description: Network partner's last name.
                      type: string
                      example: test
                    email:
                      description: Network partner contact's email id.
                      type: string
                      format: email
                      example: emergetest@emergetms.com
                    phone:
                      description: Network partner contact's phone number.
                      $ref: '#/components/schemas/phone_response_object'
                tags:
                  $ref: '#/components/schemas/tags_object'
    Current_Marketplace_Option_Event:
      type: object
      description: This object contains the current marketplace option details. Whenever there is a change in the current
        marketplace option this event will get triggered and notify the consumer.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: b07a0000-ff1b-0003-e106-08d909433d91
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-04-27T06:11:05.4316652+00:00'
        event_type:
          description: The event type name
          type: string
          example: current_marketplace_option
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            count_of_active_options:
              description: The count of active options.
              type: integer
              example: 1
            current_option:
              description: The current option identifier.
              type: object
              properties:
                id:
                  description: The id of the option.
                  type: integer
                  example: 74844
                opportunity_id:
                  description: The opportunity id.
                  type: integer
                  example: 174344
                availability_date:
                  description: Availability date of the option.
                  type: string
                  example: '2020-10-28T07:53:59.402Z'
                modified_date:
                  description: Modified date of the option.
                  type: string
                  example: '2021-10-28T07:53:59.402'
                created_date:
                  description: Created date of the option.
                  type: string
                  example: '2021-10-28T07:53:59.402'
                rate:
                  description: The rate for the shipment in USD.
                  type: number
                  example: 110.75
            references:
              description: References for the opportunity.
              type: array
              items:
                type: object
                properties:
                  type_id:
                    description: The reference type id.
                    type: string
                    example: Customer
                  value:
                    description: The selected reference value.
                    type: string
                    example: CustRef123
    Opportunity_Deleted_Event:
      type: object
      description: This object contains an opportunity identifier and references. Whenever an opportunity is deleted this
        event will get triggered and notify the consumer.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: d6400000-9bf2-98fa-9c6e-08d97107db8a
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-09-06T06:11:05.4316652+00:00'
        event_type:
          description: The event type name
          type: string
          example: opportunity_deleted
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            opportunity_id:
              description: The opportunity id.
              type: integer
              example: 44521
            references:
              description: References for the opportunity.
              type: array
              items:
                type: object
                properties:
                  type_id:
                    description: The reference type id.
                    type: string
                    example: Customer
                  value:
                    description: The selected reference value.
                    type: string
                    example: CustRef433
    delivery_status_updated_Event:
      type: object
      description: The tracking events share a common object structure with the exception of ‘event_data’ object, which can
        change slightly depending on the updates.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: 60e6d639-5f61-4a0b-b563-cf4d92cec2cc
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2019-07-17T12:45:11.5130697+00:00'
        event_type:
          description: The event type name
          type: string
          example: delivery_status_updated
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            new_state:
              description: The current state of the event object. The webhook event data state object.
              type: object
              properties:
                delivery_status_id:
                  $ref: '#/components/schemas/delivery_Status'
            old_state:
              description: The previous state of this event object. The webhook event data state object.
              type: object
              properties:
                delivery_status_id:
                  $ref: '#/components/schemas/delivery_Status'
            stop_id:
              description: The stop id.
              type: integer
              example: 3773
            stop_sequence:
              description: The sequence of the stop.
              type: integer
              example: 1
        shipment:
          $ref: '#/components/schemas/tracking_shipment_object'
    tracking_status_updated_Event:
      type: object
      description: The tracking events share a common object structure with the exception of ‘event_data’ object, which can
        change slightly depending on the updates.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: 60e6d639-5f61-4a0b-b563-cf4d92cec2cc
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2019-07-17T12:45:11.5130697+00:00'
        event_type:
          description: The event type name
          type: string
          example: tracking_status_updated
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            new_state:
              description: The current state of the event object. The webhook event data state object.
              type: object
              properties:
                tracking_status_id:
                  description: The Tracking status of the shipment.
                  type: string
                  enum:
                  - TenderAccepted: 1
                  - Dispatched: 4
                  - InTransit: 5
                  - Delivered: 6
                  - Completed: 8
                  - Canceled: 9
                  - AtShipper: 10
                  - AtConsignee: 11
                  example: 1
                last_status_update:
                  description: The date/time at which the status update occurred.This is a date/time offset.
                  type: string
                  example: '2019-07-17T12:37:04.5697743+00:00'
            old_state:
              description: The old state of the event object. The webhook event data state object.
              type: object
              properties:
                tracking_status_id:
                  description: The Tracking status of the shipment.
                  type: string
                  enum:
                  - TenderAccepted: 1
                  - Dispatched: 4
                  - InTransit: 5
                  - Delivered: 6
                  - Completed: 8
                  - Canceled: 9
                  - AtShipper: 10
                  - AtConsignee: 11
                  example: 1
                last_status_update:
                  description: The date/time at which the status update occurred. This is a date/time offset.
                  type: string
                  example: '2019-07-17T12:37:04.5697743+00:00'
        shipment:
          $ref: '#/components/schemas/tracking_shipment_object'
    stop_actual_times_updated_Event:
      type: object
      description: The user can be notified via this event when an actual arrival or departure information is received in
        the Emerge system. The old state will be an empty object if there was no previous data (on creation).
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: 60e6d639-5f61-4a0b-b563-cf4d92cec2cc
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2019-07-17T12:45:11.5130697+00:00'
        event_type:
          description: The event type name
          type: string
          example: stop_actual_times_updated
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            new_state:
              description: The current state of the event object. The webhook event data state object.
              type: object
              properties:
                action_date:
                  description: The date/time at which the action took place.This is a date/time offset.
                  type: string
                  example: '2019-07-18T17:00:00+00:00'
            old_state:
              description: The previous state of this event object. The webhook event data state object.
              type: object
              properties:
                action_date:
                  description: The date/time at which the action took place. This is a date/time offset.
                  type: string
            type_id:
              description: The stop type id.
              type: string
              enum:
              - Arrival: 1
              - Departure: 2
              example: 1
            stop_id:
              description: The stop id.
              type: integer
              example: 3773
            stop_sequence:
              description: The sequence number of the stop
              type: integer
              example: 1
        shipment:
          $ref: '#/components/schemas/tracking_shipment_object'
    current_location_updated_Event:
      type: object
      description: The tracking events share a common object structure with the exception of ‘event_data’ object, which can
        change slightly depending on the updates.
      properties:
        id:
          description: The unique identifier for this event. This is a guid.
          type: string
          example: 60e6d639-5f61-4a0b-b563-cf4d92cec2cc
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2019-07-17T12:45:11.5130697+00:00'
        event_type:
          description: The event type name
          type: string
          example: current_location_updated_job
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            city:
              description: City of the location.
              type: string
              example: Escondido
            state:
              description: State of the location.
              type: string
              example: CA
            country:
              description: Country of the location.
              type: string
              example: US
            latitude:
              description: Latitude of the location.
              type: number
              example: 33.11565900000001
            longitude:
              description: Longitude of the location.
              type: number
              example: -117.119979
            timestamp:
              description: The time that this location information was received by Emerge system. This is a date/time offset.
              type: string
              example: '2019-07-17T15:47:00-07:00'
        shipment:
          $ref: '#/components/schemas/tracking_shipment_object'
    Opportunity_NotAwarded_Event:
      type: object
      description: This object contains an opportunity identifier and references. When an opportunity is not awarded at the
        end of the bid duration then this event will get triggered and notify the subscribers.
      properties:
        id:
          description: The unique identifier for this event.
          type: string
          example: d6400000-9bf2-98fa-9c6e-08d97107db8a
        timestamp:
          description: The date/time this event was created in the emerge application. This is a date/time offset.
          type: string
          example: '2021-09-06T06:11:05.4316652+00:00'
        event_type:
          description: The event type name
          type: string
          example: opportunity_not_awarded
        event_data:
          description: This data object contains all the details associated with the event.
          type: object
          properties:
            opportunity_id:
              description: The opportunity id.
              type: integer
              example: 44521
            references:
              description: References for the opportunity.
              type: array
              items:
                type: object
                properties:
                  type_id:
                    description: The reference type id.
                    type: string
                    example: Customer
                  value:
                    description: The selected reference value.
                    type: string
                    example: CustRef433
  responses:
    '400':
      description: 400 | Bad Request. A bad request was made. Please try again
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/400_badrequest_response'
    '401':
      description: 401 | Not Authorized. The request was not authorized. Please add or refresh your authorization token
    '403':
      description: 403 | Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/403_forbidden_response'
    '404':
      description: 404 | Not Found. The requested resource was not found
    '409':
      description: 409 | Conflict. A conflict has occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/409_response'
    '429':
      description: 429 | Too many requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/429_response'
    '500':
      description: 500 | Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/500_response'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer