openapi: 3.0.2
info:
  title: Triumph Intelligence Connect
  x-logo:
    url: https://static.greenscreens.ai/main-logo.svg
    backgroundColor: "#fafafa"
    altText: Triumph Intelligence
  description: >
    # Authentication



    Triumph Intelligence API offers OAuth2 Bearer JWT token based authentication.



    OAuth2 - an open protocol to allow secure authorization in a simple 

    and standard method from web, mobile and desktop applications.



    # 



    # 



    # Direct link integration with Triumph Intelligence


    One of the simplest ways to integrate Triumph Intelligence in to your app is by using the 

    direct link method.


    Link format:

        https://intelligence.triumph.io/rates?originZip={}&destinationZip={}&transportType={}

    * originZip - 5 digit USA ZIP code of the origin point


    * destinationZip - 5 digit USA ZIP code of the destination point


    * transportType - one of supported equipment types VAN, REEFER or FLATBED


    * OPTIONAL: pickupDate - pickup date string in ISO format e.g. "2022-04-06T08:00:00.000+03:00" when not encoded


    * OPTIONAL: originCityState - city and state separated by a space symbol, signifying the origin point. 

    Can be used instead of originZip if you do not have a zip code of the location. 

    _Should not be used together with originZip._


    * OPTIONAL: destinationCityState - city and state separated by a space, signifying the destination point. 

    Can be used instead of destinationZip if you do not have a zip code of the location. 

    _Should not be used together with destinationZip._


    * OPTIONAL: customer - name of the customer company


    * OPTIONAL: commodity - description of the transported commodity


    * OPTIONAL: weight - weight of the load in lbs


    * OPTIONAL: deliveryDate - delivery date string in ISO format e.g. "2022-04-06T08:00:00.000+03:00" when not encoded


    * OPTIONAL: extraStops - any extra stops between origin and destination. Value is an array of strings with up to 10 elements

    in the format of `{order}_{type}_{country}_{address}` 

    types are `{numbers 0-9}_{CITY or ZIP}_{US or CA}_{if ZIP then 5+ digits, if CITY then city state string separated by space}`


    Examples (don't forget to encode the url):

        https://intelligence.triumph.io/rates?originZip=12345&destinationZip=62345&transportType=VAN

        https://intelligence.triumph.io/rates?originCityState=Wausau%20WI&destinationCityState=Evansville%20IN&transportType=VAN

        https://intelligence.triumph.io/rates?originZip=12345&destinationCityState=Evansville%20IN&transportType=VAN

        https://intelligence.triumph.io/rates?originZip=12345&destinationZip=62345&extraStops=0_ZIP_US_28086&extraStops=1_CITY_US_Portland%20OR&transportType=VAN

    Example usage:

        <button
          onclick="location.href='https://intelligence.triumph.io/rates?destinationZip=62345&originZip=12345&transportType=VAN'"
          type="button">Quote new lane
        <button>


    # 



    # 



    # Services and endpoints


    The most versatile (and involving the most work) way of integration is by using our API directly.

    Below you can find a list of servises and endpoints available for usage.
  version: 1.3.3
  termsOfService: https://triumph.io/terms-of-service/
  contact:
    name: API Support
    email: support@greenscreens.ai
    url: https://connect.intelligence.triumph.io
tags:
  - name: Auth
    description: Authentication service
    x-displayName: Auth
  - name: Analytics
    description: >-
      Analytics service v1


      <a href="/analytics/v1/redoc/" target="_blank">View separately</a>


      <a href="/analytics/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: Analytics
  - name: Bids
    description: >-
      Carrier bids service v1


      <a href="/bids/v1/redoc/" target="_blank">View separately</a>


      <a href="/bids/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: Bids
  - name: Datalake
    description: >-
      Datalake service v1


      <a href="/datalake/v1/redoc/" target="_blank">View separately</a>


      <a href="/datalake/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: Datalake
  - name: History
    description: >-
      Historical rate data and similar lanes analysis v1


      <a href="/history/v1/redoc/" target="_blank">View separately</a>


      <a href="/history/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: History
  - name: MarketIntelligence
    description: >-
      Market Intelligence service v1


      <a href="/marketintelligence/v1/redoc/" target="_blank">View separately</a>


      <a href="/marketintelligence/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: MarketIntelligence
  - name: Prediction
    description: >-
      Prediction service v3


      <a href="/prediction/v3/redoc/" target="_blank">View separately</a>


      <a href="/prediction/v3/swagger/index.html" target="_blank">Try it in swagger</a>


      Older version of this api exists. <a href="/prediction/v2/redoc/" target="_blank">View v2 here</a>
    x-displayName: Prediction
  - name: Pricing
    description: >-
      Pricing service v1


      <a href="/pricing/v1/redoc/" target="_blank">View separately</a>


      <a href="/pricing/v1/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: Pricing
  - name: Quotes
    description: >-
      Quotes service v2


      <a href="/quotes/v2/redoc/" target="_blank">View separately</a>


      <a href="/quotes/v2/swagger/index.html" target="_blank">Try it in swagger</a>


      Older version of this api exists. <a href="/quotes/v1/redoc/" target="_blank">View v1 here</a>
    x-displayName: Quotes
  - name: TMS
    description: >-
      TmsConnector service v2


      <a href="/tmsconnector/v2/redoc/" target="_blank">View separately</a>


      <a href="/tmsconnector/v2/swagger/index.html" target="_blank">Try it in swagger</a>
    x-displayName: TMS
x-tagGroups:
  - name: Auth
    tags:
      - Auth
    description: >
      # Authentication



      Triumph Intelligence API offers OAuth2 Bearer JWT token based authentication.



      OAuth2 - an open protocol to allow secure authorization in a simple 

      and standard method from web, mobile and desktop applications.



      # 



      # 



      # Direct link integration with Triumph Intelligence


      One of the simplest ways to integrate Triumph Intelligence in to your app is by using the 

      direct link method.


      Link format:

          https://intelligence.triumph.io/rates?originZip={}&destinationZip={}&transportType={}

      * originZip - 5 digit USA ZIP code of the origin point


      * destinationZip - 5 digit USA ZIP code of the destination point


      * transportType - one of supported equipment types VAN, REEFER or FLATBED


      * OPTIONAL: pickupDate - pickup date string in ISO format e.g. "2022-04-06T08:00:00.000+03:00" when not encoded


      * OPTIONAL: originCityState - city and state separated by a space symbol, signifying the origin point. 

      Can be used instead of originZip if you do not have a zip code of the location. 

      _Should not be used together with originZip._


      * OPTIONAL: destinationCityState - city and state separated by a space, signifying the destination point. 

      Can be used instead of destinationZip if you do not have a zip code of the location. 

      _Should not be used together with destinationZip._


      * OPTIONAL: customer - name of the customer company


      * OPTIONAL: commodity - description of the transported commodity


      * OPTIONAL: weight - weight of the load in lbs


      * OPTIONAL: deliveryDate - delivery date string in ISO format e.g. "2022-04-06T08:00:00.000+03:00" when not encoded


      * OPTIONAL: extraStops - any extra stops between origin and destination. Value is an array of strings with up to 10 elements

      in the format of `{order}_{type}_{country}_{address}` 

      types are `{numbers 0-9}_{CITY or ZIP}_{US or CA}_{if ZIP then 5+ digits, if CITY then city state string separated by space}`


      Examples (don't forget to encode the url):

          https://intelligence.triumph.io/rates?originZip=12345&destinationZip=62345&transportType=VAN

          https://intelligence.triumph.io/rates?originCityState=Wausau%20WI&destinationCityState=Evansville%20IN&transportType=VAN

          https://intelligence.triumph.io/rates?originZip=12345&destinationCityState=Evansville%20IN&transportType=VAN

          https://intelligence.triumph.io/rates?originZip=12345&destinationZip=62345&extraStops=0_ZIP_US_28086&extraStops=1_CITY_US_Portland%20OR&transportType=VAN

      Example usage:

          <button
            onclick="location.href='https://intelligence.triumph.io/rates?destinationZip=62345&originZip=12345&transportType=VAN'"
            type="button">Quote new lane
          <button>


      # 



      # 



      # Services and endpoints


      The most versatile (and involving the most work) way of integration is by using our API directly.

      Below you can find a list of servises and endpoints available for usage.
  - name: analytics
    tags:
      - Analytics
    description: Analytics service v1
  - name: bids
    tags:
      - Bids
    description: Carrier bids service v1
  - name: datalake
    tags:
      - Datalake
    description: Datalake service v1
  - name: history
    tags:
      - History
    description: Historical rate data and similar lanes analysis v1
  - name: marketintelligence
    tags:
      - MarketIntelligence
    description: Market Intelligence service v1
  - name: prediction
    tags:
      - Prediction
    description: Prediction service v3
  - name: pricing
    tags:
      - Pricing
    description: Pricing service v1
  - name: quotes
    tags:
      - Quotes
    description: Quotes service v2
  - name: tmsconnector
    tags:
      - TMS
    description: TmsConnector service v2
externalDocs:
  description: Triumph Intelligence
  url: https://intelligence.triumph.io
paths:
  /auth/token:
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
    post:
      tags:
        - Auth
      security: []
      summary: Auth token
      description: >
        The request for the access token should look like this.

        ```

        curl -X POST "https://testapi.greenscreens.ai/v1/auth/token" -H "accept: application/json" \

        -H "Content-Type: application/x-www-form-urlencoded" \

        -d "grant_type=client_credentials&client_id=external-app&client_secret=78aaff56-7b86-4c92-9a1d-355f167c0619"

        ```

        You should replace `client_id` and `client_secret` with id and secret provided to you by greenscreens. 


        ---

        If an access_token that you use expires, or you receive an `unauthenticated` error,

        your application will need to obtain a new access_token.
      operationId: authToken
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                grant_type:
                  type: string
                  enum:
                    - client_credentials
                  description: Type of authorization flow, in this case should always be
                    `client_credentials`
                  example: client_credentials
                client_id:
                  type: string
                  description: Client id provided by greenscreens
                  example: external-app
                client_secret:
                  type: string
                  description: Client secret provided by greenscreens
                  example: 78aaff56-7b86-4c92-9a1d-355f167c0619
              required:
                - grant_type
                - client_id
                - client_secret
            example:
              grant_type: client_credentials
              client_id: external-app
              client_secret: 78aaff56-7b86-4c92-9a1d-355f167c0619
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    description: Access token
                  expires_in:
                    type: integer
                    description: Expiration of access token
                  refresh_expires_in:
                    type: integer
                    description: Expiration of refresh token
                  token_type:
                    type: string
                    description: Token type
                  not-before-policy:
                    type: integer
                    description: Not before policy
                  scope:
                    type: string
                    description: scope
                required:
                  - access_token
                  - expires_in
                  - token_type
                  - not-before-policy
                  - scope
              example:
                access_token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI3cmFncld0MlJuVjZaeFdZa2JLZDktOGZYV202UlRCU3Q0WE1IYWdpZFQwIn0.eyJqdGkiOiIyM2VjNzg3Ny0yMzBjLTRkODktYmYyNy0zMWFmZWQ5MDMyYjciLCJleHAiOjE1NzU0ODEwMTMsIm5iZiI6MCwiaWF0IjoxNTc1NDc3NDEzLCJpc3MiOiJodHRwOi8vdGVzdGluZy5rZXkuY2FyZ2dvLmludC9hdXRoL3JlYWxtcy9DYXJnZ29TZWN1cml0eVJlYWxtIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjhhYzNjYjljLTA1MGQtNDUzZS1hNGRhLTEzOGE5MmZlZmExNCIsInR5cCI6IkJlYXJlciIsImF6cCI6ImNhcmdnby1tZG0tYXBwIiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiN2Q4YmFhMTAtNWQwNy00ZTZmLWE3OTctOTAzMzZjOGY4MWRiIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyIqIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJUcGxNYW5hZ2VyIiwib2ZmbGluZV9hY2Nlc3MiLCJTaGlwcGVyTWFuYWdlciIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiIiLCJwcmltYXJ5Um9sZSI6IlRwbE1hbmFnZXIiLCJjb21wYW55SWQiOiIxNWNlM2Q3Yi1kYjA3LTRkOTgtYmE3Zi1hNGYxYWNmMWY3ODIiLCJjaGlsZHJlbkNvbXBhbmllcyI6WyI3NDYyOGNkZS1jMzc0LTRmOTctYThiYS1lZDFjMGIzOTdhYzQiLCI2M2Y1MWM3ZC0yYjg1LTQwMWEtYWYwMS02NTQ3YzY3ZTlkOWIiLCI3YWY0MzRmZS00Mzg5LTQ5ZDQtYTM1Ni02NjlkZGNiMDIwMDgiXSwidXNlcklkIjoiZDMzMWVhZTEtMjU4Ni00YmFlLTgxODMtN2QyZmY5ZTJmYzQ2In0.ngQ15qlArqFyQ-fRJZcHGBFZQBWsG2oXgJqsOpY8ECpQN5-VgX2zlWPATZ469qXEmFEdwGfsadk62T6fu7Qxf1elTFSw5OqXHAWKPs1myB3E-wxDe9zRZdnFm72G5uoVHyLhPwbInWTTZNzCrISQVUQq1UbcQ5K0OZxQSThTgh232qPNjl6J1KekjvAkottMTCugv0Rl1MxvCnLyyYPyKl2EACCJShJ0-xjLaU1sH68Jnt7kPC8HCfqvZUj2c9YtBKwBTkOhriPQWHEQLC8g0GMSV3Q19_fCuAkqo9qd2spLyi7K9hNI1PNSESOSPBVNPqVmip712YdtlEUE8OQ0wQ
                expires_in: 3600
                refresh_expires_in: 0
                token_type: Bearer
                not-before-policy: 1631698006
                scope: ""
        "401":
          description: Authorization information is missing or invalid
  /analytics/lane-top-carriers:
    get:
      tags:
        - Analytics
      operationId: analyticsLaneTopCarriers
      summary: Top carriers
      description: Returns a list of top carriers for a provided lane
      security:
        - Analytics_bearerAuth: []
      parameters:
        - in: query
          name: transportType
          schema:
            type: string
            enum:
              - VAN
              - REEFER
              - FLATBED
              - HOTSHOT
            description: >
              Transport type


              If you would like Hotshot predictions, reach out to your CSM and DA. 

              The model will not work properly without your hotshot data effectively filtered and imported into the model.
            example: VAN
          required: true
        - in: query
          name: originCountry
          schema:
            type: string
            example: US
          description: |
            Origin country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: originState
          schema:
            type: string
            example: NY
          description: Origin state
          required: true
        - in: query
          name: originCity
          schema:
            type: string
            example: Schenectady
          description: Origin city
          required: true
        - in: query
          name: originZip
          schema:
            type: string
            example: "12345"
          description: Origin area zip
          required: true
        - in: query
          name: destinationCountry
          schema:
            type: string
            example: US
          description: |
            Destination country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: destinationState
          schema:
            type: string
            example: IL
          description: Destination state
          required: true
        - in: query
          name: destinationCity
          schema:
            type: string
            example: Chicago
          description: Destination city
          required: true
        - in: query
          name: destinationZip
          schema:
            type: string
            example: "60636"
          description: Destination area zip
          required: true
        - in: query
          name: hasExtraStops
          schema:
            type: boolean
            example: true
            description: |
              Signifies whether the requested lane has extra stops or not.

              If true, multistop loads will be included during calculations.
            default: false
        - in: query
          name: dateFrom
          schema:
            type: string
            format: date
            example: "2019-09-30"
          description: >
            Start date of a period for which you want to calculate top
            carriers. 

            In ISO format (YYYY-MM-DD). 


            End date of this period is the current date.
          required: true
        - in: query
          name: region
          schema:
            type: string
            enum:
              - CITY
              - CITY_ZIP
              - ZIP_CITY
              - ZIP
              - 3DZIP
              - KMA
            description: >
              Determines the size of the area around the origin and destination
              points, 

              that will be searched for the related data.

              * CITY - narrow, city wide, area

              * ZIP - narrow, five digit zip, area

              * 3DZIP - medium, short zip, area

              * KMA - big, market wide, area

              * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

              * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
            example: ZIP
          required: true
        - in: query
          name: currency
          schema:
            type: string
            example: USD
          description: >
            Code of the currency that you want the response to be in.

            Format is ISO 4217.

            If not provided, defaults to the currency set in the profile of currently authenticated user.
        - in: query
          name: sort
          schema:
            type: array
            items:
              type: string
          description: >
            Sorting descriptor in format `?sort={field},{asc|desc}`. 


            Multiple sort parameters are allowed and should look like this 

            `?sort=name,asc&sort=email,desc`.


            If multiple sort parameters are passed, the results will be sorted by all of them, 

            with priority decreasing from left to right.


            So in case of `?sort=name,asc&sort=volume,desc` results will be first sorted by 

            name in ascending order, and in cases where names are equal 

            results will be sorted by volume in descending order.


            By default carriers are sorted like this: 

            `numberOfLoads,desc & lastShippedDate,desc`.


            These response fields support sorting:

            ```

            carrierName

            carrierPhone

            carrierEmail

            carrierMC

            carrierDOT

            carrierSCAC

            numberOfLoads

            lastShippedDate

            averageCarrierRate

            minCarrierRate

            maxCarrierRate

            averageCarrierFlatRate

            minCarrierFlatRate

            maxCarrierFlatRate

            averageCarrierMarginPercent

            ```
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Analytics_AnalyticsLaneTopCarriersResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: A common api error object
                properties:
                  code:
                    type: string
                    description: unique string identifier of the error
                  message:
                    type: string
                    description: human readable error message
                required:
                  - code
                  - message
                example:
                  code: invalid_request
                  message: Your ClientId is invalid
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  errors:
                    type: array
                    description: list of errors
                    items:
                      type: object
                      description: Request validation error
                      properties:
                        field:
                          type: string
                          description: Name of the field that did not pass validation
                          example: transportType
                        message:
                          type: string
                          description: Human readable error mesage explaining why validation failed
                          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
                            FLATBED, ...]
                        value:
                          type: string
                          nullable: true
                          description: Value of the field that did not pass validation
                          example: SpaceXDragon
                      required:
                        - field
                        - message
                required:
                  - code
                  - message
                  - errors
                example:
                  code: request_validation
                  message: You have one or more errors in request structure
                  errors:
                    - field: carrierName
                      message: field contains wrong data type (int), should be string
                      value: "22"
                    - field: shipperId
                      message: "shipperId: must not be null"
                      value: null
                    - field: loadSource.loadId
                      message: "loadId: must not be null"
                      value: null
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/analytics/lane-top-carriers',
              qs: {
                transportType: 'VAN',
                originCountry: 'US',
                originState: 'NY',
                originCity: 'Schenectady',
                originZip: '12345',
                destinationCountry: 'US',
                destinationState: 'IL',
                destinationCity: 'Chicago',
                destinationZip: '60636',
                hasExtraStops: 'true',
                dateFrom: '2019-09-30',
                region: 'ZIP',
                currency: 'USD',
                sort: 'SOME_ARRAY_VALUE'
              },
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/analytics/lane-top-carriers"


            querystring = {"transportType":"VAN","originCountry":"US","originState":"NY","originCity":"Schenectady","originZip":"12345","destinationCountry":"US","destinationState":"IL","destinationCity":"Chicago","destinationZip":"60636","hasExtraStops":"true","dateFrom":"2019-09-30","region":"ZIP","currency":"USD","sort":"SOME_ARRAY_VALUE"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/analytics/lane-top-carriers?transportType=VAN&originCountry=US&originState=NY&originCity=Schenectady&originZip=12345&destinationCountry=US&destinationState=IL&destinationCity=Chicago&destinationZip=60636&hasExtraStops=true&dateFrom=2019-09-30&region=ZIP&currency=USD&sort=SOME_ARRAY_VALUE",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /bids:
    post:
      tags:
        - Bids
      summary: Save bid
      description: Save bid
      security:
        - Bids_bearerAuth: []
      operationId: saveBid
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bids_BidsRequest"
        required: true
      responses:
        "201":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_BidResponse"
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/bids',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                userEmail: 'buddy@greenscreens.ai',
                carrierName: 'CarrierCompany',
                carrierMC: '888015',
                carrierDOT: '87650005',
                carrierEmail: 'carrier@mail.com',
                carrierPhone: '4112228888',
                origin: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                destination: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                extraStops: [
                  {
                    order: 0,
                    address: {country: 'US', zip: '96080'},
                    type: 'LOAD',
                    appointmentDateTime: '2020-10-14T16:00:00Z'
                  },
                  {
                    order: 1,
                    address: {country: 'US', city: 'Redding', state: 'CA'},
                    type: 'UNLOAD',
                    appointmentDateTime: '2020-10-15T16:00:00Z'
                  }
                ],
                transportType: 'VAN',
                pickupDateTime: '2020-10-13T16:00:00Z',
                deliveredDateTime: '2020-10-13T16:00:00Z',
                bidDateTime: '2020-10-11T16:00:00Z',
                bidCost: 1000.5,
                loadProNumber: 'Pro#111111',
                weight: 20000,
                commodity: 'Steel racks',
                brokerComment: 'Something a broker would comment',
                carrierComment: 'Looks good',
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids"


            payload = {
                "userEmail": "buddy@greenscreens.ai",
                "carrierName": "CarrierCompany",
                "carrierMC": "888015",
                "carrierDOT": "87650005",
                "carrierEmail": "carrier@mail.com",
                "carrierPhone": "4112228888",
                "origin": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "destination": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "extraStops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "zip": "96080"
                        },
                        "type": "LOAD",
                        "appointmentDateTime": "2020-10-14T16:00:00Z"
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA"
                        },
                        "type": "UNLOAD",
                        "appointmentDateTime": "2020-10-15T16:00:00Z"
                    }
                ],
                "transportType": "VAN",
                "pickupDateTime": "2020-10-13T16:00:00Z",
                "deliveredDateTime": "2020-10-13T16:00:00Z",
                "bidDateTime": "2020-10-11T16:00:00Z",
                "bidCost": 1000.5,
                "loadProNumber": "Pro#111111",
                "weight": 20000,
                "commodity": "Steel racks",
                "brokerComment": "Something a broker would comment",
                "carrierComment": "Looks good",
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"userEmail\":\"buddy@greenscreens.ai\",\"carrierName\":\"CarrierCompany\",\"carrierMC\":\"888015\",\"carrierDOT\":\"87650005\",\"carrierEmail\":\"carrier@mail.com\",\"carrierPhone\":\"4112228888\",\"origin\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"destination\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"extraStops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-15T16:00:00Z\"}],\"transportType\":\"VAN\",\"pickupDateTime\":\"2020-10-13T16:00:00Z\",\"deliveredDateTime\":\"2020-10-13T16:00:00Z\",\"bidDateTime\":\"2020-10-11T16:00:00Z\",\"bidCost\":1000.5,\"loadProNumber\":\"Pro#111111\",\"weight\":20000,\"commodity\":\"Steel racks\",\"brokerComment\":\"Something a broker would comment\",\"carrierComment\":\"Looks good\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    get:
      tags:
        - Bids
      summary: Get current user bids
      description: Get current user bids
      security:
        - Bids_bearerAuth: []
      operationId: getBids
      parameters:
        - in: query
          name: createdDateFrom
          description: bid created date >= value
          required: true
          schema:
            type: string
            format: date
            example: "2019-09-30"
        - in: query
          name: createdDateTo
          description: bid created date <= value
          schema:
            type: string
            format: date
            example: "2019-12-30"
        - in: query
          name: currency
          schema:
            type: string
            enum:
              - USD
              - CAD
            description: >
              Currency code in ISO 4217 format (three letter code, e.g. USD)


              _If not provided, defaults to the currency set in the profile 

              of currently authenticated user (or currently authenticated company 

              if there is no user or user profile setting)_
            example: USD
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_BidsResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_Error"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  errors:
                    type: array
                    description: list of errors
                    items:
                      $ref: "#/components/schemas/Bids_RequestValidationError"
                required:
                  - code
                  - message
                  - errors
                example:
                  code: request_validation
                  message: You have one or more errors in request structure
                  errors:
                    - field: carrierName
                      message: field contains wrong data type (int), should be string
                      value: "22"
                    - field: shipperId
                      message: "shipperId: must not be null"
                      value: null
                    - field: loadSource.loadId
                      message: "loadId: must not be null"
                      value: null
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/bids',
              qs: {createdDateFrom: '2019-09-30', createdDateTo: '2019-12-30', currency: 'USD'},
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids"


            querystring = {"createdDateFrom":"2019-09-30","createdDateTo":"2019-12-30","currency":"USD"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids?createdDateFrom=2019-09-30&createdDateTo=2019-12-30&currency=USD",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  "/bids/{bidId}":
    patch:
      tags:
        - Bids
      summary: Update bid
      description: Update bid
      security:
        - Bids_bearerAuth: []
      operationId: updateBid
      parameters:
        - in: path
          name: bidId
          description: Id of the bid that you want updated
          required: true
          schema:
            type: integer
            format: int64
            example: 12345
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bids_BidsUpdateRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_BidObject"
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'PATCH',
              url: 'https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                carrierName: 'CarrierCompany',
                carrierMC: '888015',
                carrierEmail: 'carrier@mail.com',
                carrierPhone: '4112228888',
                origin: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                destination: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                extraStops: [
                  {
                    order: 0,
                    address: {country: 'US', zip: '96080'},
                    type: 'LOAD',
                    appointmentDateTime: '2020-10-14T16:00:00Z'
                  },
                  {
                    order: 1,
                    address: {country: 'US', city: 'Redding', state: 'CA'},
                    type: 'UNLOAD',
                    appointmentDateTime: '2020-10-15T16:00:00Z'
                  }
                ],
                transportType: 'VAN',
                pickupDateTime: '2020-10-13T16:00:00Z',
                deliveredDateTime: '2020-10-13T16:00:00Z',
                bidDateTime: '2020-10-11T16:00:00Z',
                bidCost: 1000.5,
                loadProNumber: 'Pro#111111',
                weight: 20000,
                commodity: 'Steel racks',
                brokerComment: 'Something a broker would comment',
                carrierComment: 'Looks good',
                wasViewed: false,
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D"


            payload = {
                "carrierName": "CarrierCompany",
                "carrierMC": "888015",
                "carrierEmail": "carrier@mail.com",
                "carrierPhone": "4112228888",
                "origin": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "destination": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "extraStops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "zip": "96080"
                        },
                        "type": "LOAD",
                        "appointmentDateTime": "2020-10-14T16:00:00Z"
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA"
                        },
                        "type": "UNLOAD",
                        "appointmentDateTime": "2020-10-15T16:00:00Z"
                    }
                ],
                "transportType": "VAN",
                "pickupDateTime": "2020-10-13T16:00:00Z",
                "deliveredDateTime": "2020-10-13T16:00:00Z",
                "bidDateTime": "2020-10-11T16:00:00Z",
                "bidCost": 1000.5,
                "loadProNumber": "Pro#111111",
                "weight": 20000,
                "commodity": "Steel racks",
                "brokerComment": "Something a broker would comment",
                "carrierComment": "Looks good",
                "wasViewed": False,
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("PATCH", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "PATCH",
              CURLOPT_POSTFIELDS => "{\"carrierName\":\"CarrierCompany\",\"carrierMC\":\"888015\",\"carrierEmail\":\"carrier@mail.com\",\"carrierPhone\":\"4112228888\",\"origin\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"destination\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"extraStops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-15T16:00:00Z\"}],\"transportType\":\"VAN\",\"pickupDateTime\":\"2020-10-13T16:00:00Z\",\"deliveredDateTime\":\"2020-10-13T16:00:00Z\",\"bidDateTime\":\"2020-10-11T16:00:00Z\",\"bidCost\":1000.5,\"loadProNumber\":\"Pro#111111\",\"weight\":20000,\"commodity\":\"Steel racks\",\"brokerComment\":\"Something a broker would comment\",\"carrierComment\":\"Looks good\",\"wasViewed\":false,\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    delete:
      tags:
        - Bids
      summary: Delete bid
      description: Delete bid
      security:
        - Bids_bearerAuth: []
      operationId: deleteBid
      parameters:
        - in: path
          name: bidId
          description: Id of the bid that you want deleted
          required: true
          schema:
            type: integer
            format: int64
            example: 12345
      responses:
        "204":
          description: Success
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'DELETE',
              url: 'https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D',
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: |-
            import requests

            url = "https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D"

            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}

            response = requests.request("DELETE", url, headers=headers)

            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/%7BbidId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "DELETE",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /bids/carriers:
    get:
      tags:
        - Bids
      summary: Search carriers
      description: Search carriers
      security:
        - Bids_bearerAuth: []
      operationId: carrierInfo
      parameters:
        - in: query
          name: query
          description: >
            Query string. Names are first checked using case insensitive
            startsWith  and then case insensitive contains.
          schema:
            type: string
            example: Joe
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_CarrierInfoResponse"
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/bids/carriers',
              qs: {query: 'Joe'},
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids/carriers"


            querystring = {"query":"Joe"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/carriers?query=Joe",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /bids/accept:
    post:
      tags:
        - Bids
      summary: Accept bid
      description: Accept bid
      operationId: acceptBid
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bids_BidActionRequest"
        required: true
      responses:
        "204":
          description: Success
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/bids/accept',
              headers: {'content-type': 'application/json'},
              body: {
                key: 'c5d1cfa8-228b-11eb-adc1-0242ac120002',
                bidCost: 1000.5,
                carrierName: 'Carrierr Transportation',
                carrierMC: '888015',
                carrierComment: 'Looks good',
                currency: 'USD'
              },
              json: true
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids/accept"


            payload = {
                "key": "c5d1cfa8-228b-11eb-adc1-0242ac120002",
                "bidCost": 1000.5,
                "carrierName": "Carrierr Transportation",
                "carrierMC": "888015",
                "carrierComment": "Looks good",
                "currency": "USD"
            }

            headers = {"content-type": "application/json"}


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/accept",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"key\":\"c5d1cfa8-228b-11eb-adc1-0242ac120002\",\"bidCost\":1000.5,\"carrierName\":\"Carrierr Transportation\",\"carrierMC\":\"888015\",\"carrierComment\":\"Looks good\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /bids/send:
    post:
      tags:
        - Bids
      summary: Send bid request
      description: Send bid request to a carrier
      security:
        - Bids_bearerAuth: []
      operationId: requestBid
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bids_BidsSendRequest"
        required: true
      responses:
        "204":
          description: Success
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/bids/send',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                userEmail: 'buddy@greenscreens.ai',
                carriers: [
                  {
                    carrierInfo: {
                      name: 'CarrierCompany',
                      mc: '888015',
                      dot: '87650005',
                      phone: '4112228888',
                      email: 'carrier@mail.com'
                    },
                    carrierInfoSource: 'HIGHWAY',
                    sendRequestTo: ['CARRIER_INFO_EMAIL']
                  }
                ],
                carrierEmailList: ['carrier1@mail.com', 'carrier2@mail.com', 'carrier3@mail.com'],
                carrierPhoneList: ['8456951387', '7456951583', '2458951391'],
                origin: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                destination: {country: 'US', state: 'NY', city: 'Schenectady', zip: '12345', type: 'ZIP'},
                extraStops: [
                  {
                    order: 0,
                    address: {country: 'US', zip: '96080'},
                    type: 'LOAD',
                    appointmentDateTime: '2020-10-14T16:00:00Z'
                  },
                  {
                    order: 1,
                    address: {country: 'US', city: 'Redding', state: 'CA'},
                    type: 'UNLOAD',
                    appointmentDateTime: '2020-10-15T16:00:00Z'
                  }
                ],
                pickupDateTime: '2020-10-13T16:00:00Z',
                deliveredDateTime: '2020-10-13T16:00:00Z',
                loadProNumber: 'Pro#111111',
                weight: 20000,
                commodity: 'Steel racks',
                brokerComment: 'Please, be carefully with my load',
                transportType: 'VAN'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids/send"


            payload = {
                "userEmail": "buddy@greenscreens.ai",
                "carriers": [
                    {
                        "carrierInfo": {
                            "name": "CarrierCompany",
                            "mc": "888015",
                            "dot": "87650005",
                            "phone": "4112228888",
                            "email": "carrier@mail.com"
                        },
                        "carrierInfoSource": "HIGHWAY",
                        "sendRequestTo": ["CARRIER_INFO_EMAIL"]
                    }
                ],
                "carrierEmailList": ["carrier1@mail.com", "carrier2@mail.com", "carrier3@mail.com"],
                "carrierPhoneList": ["8456951387", "7456951583", "2458951391"],
                "origin": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "destination": {
                    "country": "US",
                    "state": "NY",
                    "city": "Schenectady",
                    "zip": "12345",
                    "type": "ZIP"
                },
                "extraStops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "zip": "96080"
                        },
                        "type": "LOAD",
                        "appointmentDateTime": "2020-10-14T16:00:00Z"
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA"
                        },
                        "type": "UNLOAD",
                        "appointmentDateTime": "2020-10-15T16:00:00Z"
                    }
                ],
                "pickupDateTime": "2020-10-13T16:00:00Z",
                "deliveredDateTime": "2020-10-13T16:00:00Z",
                "loadProNumber": "Pro#111111",
                "weight": 20000,
                "commodity": "Steel racks",
                "brokerComment": "Please, be carefully with my load",
                "transportType": "VAN"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/send",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"userEmail\":\"buddy@greenscreens.ai\",\"carriers\":[{\"carrierInfo\":{\"name\":\"CarrierCompany\",\"mc\":\"888015\",\"dot\":\"87650005\",\"phone\":\"4112228888\",\"email\":\"carrier@mail.com\"},\"carrierInfoSource\":\"HIGHWAY\",\"sendRequestTo\":[\"CARRIER_INFO_EMAIL\"]}],\"carrierEmailList\":[\"carrier1@mail.com\",\"carrier2@mail.com\",\"carrier3@mail.com\"],\"carrierPhoneList\":[\"8456951387\",\"7456951583\",\"2458951391\"],\"origin\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"destination\":{\"country\":\"US\",\"state\":\"NY\",\"city\":\"Schenectady\",\"zip\":\"12345\",\"type\":\"ZIP\"},\"extraStops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-15T16:00:00Z\"}],\"pickupDateTime\":\"2020-10-13T16:00:00Z\",\"deliveredDateTime\":\"2020-10-13T16:00:00Z\",\"loadProNumber\":\"Pro#111111\",\"weight\":20000,\"commodity\":\"Steel racks\",\"brokerComment\":\"Please, be carefully with my load\",\"transportType\":\"VAN\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /bids/recent:
    get:
      tags:
        - Bids
      summary: Get ten most recent bids for a lane
      description: Get ten most recent bids for a lane
      operationId: recentBids
      security:
        - Bids_bearerAuth: []
      parameters:
        - in: query
          name: transportType
          schema:
            type: string
            enum:
              - VAN
              - REEFER
              - FLATBED
              - HOTSHOT
            description: Transport type
            example: VAN
          required: true
        - in: query
          name: originCountry
          schema:
            type: string
            example: US
          description: |
            Origin country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: originState
          schema:
            type: string
            description: Origin state
            example: NY
        - in: query
          name: originCity
          schema:
            type: string
            description: Origin city
            example: Schenectady
        - in: query
          name: originZip
          schema:
            type: string
            example: "12345"
            description: Origin area zip
          required: true
        - in: query
          name: destinationCountry
          schema:
            type: string
            example: US
          description: |
            Destination country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: destinationState
          schema:
            type: string
            description: Destination state
            example: IL
        - in: query
          name: destinationCity
          schema:
            type: string
            description: Destination city
            example: Chicago
        - in: query
          name: destinationZip
          schema:
            type: string
            example: "60636"
            description: Destination area zip
          required: true
        - in: query
          name: hasExtraStops
          schema:
            type: boolean
            example: true
            description: |
              Signifies whether the requested lane has extra stops or not.

              If true, multistop loads will be included during calculations.
            default: false
        - in: query
          name: dateFrom
          schema:
            type: string
            format: date
            example: "2019-09-30"
            description: Date range for bids created from
          required: true
        - in: query
          name: region
          schema:
            type: string
            enum:
              - CITY
              - CITY_ZIP
              - ZIP_CITY
              - ZIP
              - 3DZIP
              - KMA
            description: >
              Determines the size of the area around the origin and destination
              points, 

              that will be searched for the related data.

              * CITY - narrow, city wide, area

              * ZIP - narrow, five digit zip, area

              * 3DZIP - medium, short zip, area

              * KMA - big, market wide, area

              * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

              * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
            example: ZIP
          required: true
        - in: query
          name: currency
          schema:
            type: string
            enum:
              - USD
              - CAD
            description: >
              Currency code in ISO 4217 format (three letter code, e.g. USD)


              _If not provided, defaults to the currency set in the profile 

              of currently authenticated user (or currently authenticated company 

              if there is no user or user profile setting)_
            example: USD
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_RecentBidsResponse"
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/bids/recent',
              qs: {
                transportType: 'VAN',
                originCountry: 'US',
                originState: 'NY',
                originCity: 'Schenectady',
                originZip: '12345',
                destinationCountry: 'US',
                destinationState: 'IL',
                destinationCity: 'Chicago',
                destinationZip: '60636',
                hasExtraStops: 'true',
                dateFrom: '2019-09-30',
                region: 'ZIP',
                currency: 'USD'
              },
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/bids/recent"


            querystring = {"transportType":"VAN","originCountry":"US","originState":"NY","originCity":"Schenectady","originZip":"12345","destinationCountry":"US","destinationState":"IL","destinationCity":"Chicago","destinationZip":"60636","hasExtraStops":"true","dateFrom":"2019-09-30","region":"ZIP","currency":"USD"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/recent?transportType=VAN&originCountry=US&originState=NY&originCity=Schenectady&originZip=12345&destinationCountry=US&destinationState=IL&destinationCity=Chicago&destinationZip=60636&hasExtraStops=true&dateFrom=2019-09-30&region=ZIP&currency=USD",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  "/bids/by-key/{key}":
    get:
      tags:
        - Bids
      summary: Get bid information by key
      description: Get bid information by key
      operationId: getBidByKey
      parameters:
        - in: path
          name: key
          description: Key of the requested bid
          required: true
          schema:
            type: string
            example: 69bb0a85-f0d0-4d40-abb5-b0e6d82cd234
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bids_BidByKeyResponse"
        "400":
          $ref: "#/paths/~1bids/get/responses/400"
        "401":
          $ref: "#/paths/~1bids/get/responses/401"
        "403":
          $ref: "#/paths/~1bids/get/responses/403"
        "404":
          $ref: "#/paths/~1bids/get/responses/404"
        "422":
          $ref: "#/paths/~1bids/get/responses/422"
        "429":
          $ref: "#/paths/~1bids/get/responses/429"
        "500":
          $ref: "#/paths/~1bids/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {method: 'GET', url: 'https://testapi.greenscreens.ai/v1/bids/by-key/%7Bkey%7D'};


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: |-
            import requests

            url = "https://testapi.greenscreens.ai/v1/bids/by-key/%7Bkey%7D"

            response = requests.request("GET", url)

            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/bids/by-key/%7Bkey%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /history/loads:
    post:
      tags:
        - History
      operationId: loadsHistory
      summary: Load history search
      description: |
        Returns loads matching the search criteria
      security:
        - History_bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/History_LoadsHistoryRequest"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_LoadsHistoryResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/history/loads',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                originCountry: 'US',
                originState: 'NY',
                originCity: 'Schenectady',
                originZip: '12345',
                destinationCountry: 'US',
                destinationState: 'IL',
                destinationCity: 'Chicago',
                destinationZip: '12345',
                extraStops: [
                  {
                    order: 0,
                    type: 'LOAD',
                    address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'}
                  },
                  {
                    order: 1,
                    type: 'UNLOAD',
                    address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'}
                  }
                ],
                dateFrom: '2020-07-21',
                dateTo: '2020-07-21',
                transportType: 'VAN',
                region: 'ZIP',
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/history/loads"


            payload = {
                "originCountry": "US",
                "originState": "NY",
                "originCity": "Schenectady",
                "originZip": "12345",
                "destinationCountry": "US",
                "destinationState": "IL",
                "destinationCity": "Chicago",
                "destinationZip": "12345",
                "extraStops": [
                    {
                        "order": 0,
                        "type": "LOAD",
                        "address": {
                            "country": "US",
                            "city": "Red Bluff",
                            "state": "CA",
                            "zip": "96080"
                        }
                    },
                    {
                        "order": 1,
                        "type": "UNLOAD",
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA",
                            "zip": "96002"
                        }
                    }
                ],
                "dateFrom": "2020-07-21",
                "dateTo": "2020-07-21",
                "transportType": "VAN",
                "region": "ZIP",
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/history/loads",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"originCountry\":\"US\",\"originState\":\"NY\",\"originCity\":\"Schenectady\",\"originZip\":\"12345\",\"destinationCountry\":\"US\",\"destinationState\":\"IL\",\"destinationCity\":\"Chicago\",\"destinationZip\":\"12345\",\"extraStops\":[{\"order\":0,\"type\":\"LOAD\",\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"}},{\"order\":1,\"type\":\"UNLOAD\",\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"}}],\"dateFrom\":\"2020-07-21\",\"dateTo\":\"2020-07-21\",\"transportType\":\"VAN\",\"region\":\"ZIP\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /history/recent:
    post:
      tags:
        - History
      summary: Recent customer's rate
      description: |
        Provides recent rate for route. Returns aggregated rate statistics
        for three time periods: last 7, 15, and 30 days.
      security:
        - History_bearerAuth: []
      operationId: recentRates
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/History_RecentRatesRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_RecentRatesResponse"
        "400":
          $ref: "#/paths/~1history~1loads/post/responses/400"
        "401":
          $ref: "#/paths/~1history~1loads/post/responses/401"
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  errors:
                    type: array
                    description: list of errors
                    items:
                      type: object
                      description: Request validation error
                      properties:
                        field:
                          type: string
                          description: Name of the field that did not pass validation
                          example: transportType
                        message:
                          type: string
                          description: Human readable error mesage explaining why validation failed
                          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
                            FLATBED, ...]
                        value:
                          type: string
                          nullable: true
                          description: Value of the field that did not pass validation
                          example: SpaceXDragon
                      required:
                        - field
                        - message
                required:
                  - code
                  - message
                  - errors
                example:
                  code: request_validation
                  message: You have one or more errors in request structure
                  errors:
                    - field: carrierName
                      message: field contains wrong data type (int), should be string
                      value: "22"
                    - field: shipperId
                      message: "shipperId: must not be null"
                      value: null
                    - field: loadSource.loadId
                      message: "loadId: must not be null"
                      value: null
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "424":
          description: Failed Dependency.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/History_Error"
              examples:
                error424Example:
                  value:
                    code: distance_calculation_error
                    message: "Unable to calculate distance between zips {key}, reason:  {exc}"
        "429":
          $ref: "#/paths/~1history~1loads/post/responses/429"
        "500":
          $ref: "#/paths/~1history~1loads/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/history/recent',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                originCountry: 'US',
                originState: 'NY',
                originCity: 'Schenectady',
                originZip: '12345',
                destinationCountry: 'US',
                destinationState: 'IL',
                destinationCity: 'Chicago',
                destinationZip: '60636',
                extraStops: [
                  {
                    order: 0,
                    type: 'LOAD',
                    address: {country: 'US', state: 'CA', city: 'Red Bluff', zip: '96080'}
                  },
                  {
                    order: 1,
                    type: 'UNLOAD',
                    address: {country: 'US', state: 'CA', city: 'Redding', zip: '96002'}
                  }
                ],
                transportType: 'VAN',
                region: 'ZIP',
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/history/recent"


            payload = {
                "originCountry": "US",
                "originState": "NY",
                "originCity": "Schenectady",
                "originZip": "12345",
                "destinationCountry": "US",
                "destinationState": "IL",
                "destinationCity": "Chicago",
                "destinationZip": "60636",
                "extraStops": [
                    {
                        "order": 0,
                        "type": "LOAD",
                        "address": {
                            "country": "US",
                            "state": "CA",
                            "city": "Red Bluff",
                            "zip": "96080"
                        }
                    },
                    {
                        "order": 1,
                        "type": "UNLOAD",
                        "address": {
                            "country": "US",
                            "state": "CA",
                            "city": "Redding",
                            "zip": "96002"
                        }
                    }
                ],
                "transportType": "VAN",
                "region": "ZIP",
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/history/recent",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"originCountry\":\"US\",\"originState\":\"NY\",\"originCity\":\"Schenectady\",\"originZip\":\"12345\",\"destinationCountry\":\"US\",\"destinationState\":\"IL\",\"destinationCity\":\"Chicago\",\"destinationZip\":\"60636\",\"extraStops\":[{\"order\":0,\"type\":\"LOAD\",\"address\":{\"country\":\"US\",\"state\":\"CA\",\"city\":\"Red Bluff\",\"zip\":\"96080\"}},{\"order\":1,\"type\":\"UNLOAD\",\"address\":{\"country\":\"US\",\"state\":\"CA\",\"city\":\"Redding\",\"zip\":\"96002\"}}],\"transportType\":\"VAN\",\"region\":\"ZIP\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /marketintelligence/negotiation-advice:
    get:
      tags:
        - MarketIntelligence
      summary: Negotiation advice for provided lane
      description: |
        Negotiation advice for provided lane

        Parameter notes:
        * __region__ - defaults to ZIP if not provided
      security:
        - MarketIntelligence_bearerAuth: []
      operationId: negotiation
      parameters:
        - in: query
          name: transportType
          schema:
            type: string
            enum:
              - VAN
              - REEFER
              - FLATBED
              - HOTSHOT
            description: >
              Transport type


              If you would like Hotshot predictions, reach out to your CSM and DA. 

              The model will not work properly without your hotshot data effectively filtered and imported into the model.
            example: VAN
          required: true
        - in: query
          name: originCountry
          schema:
            type: string
            example: US
          description: |
            Origin country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: originState
          schema:
            type: string
            example: NY
          description: Origin state
        - in: query
          name: originCity
          schema:
            type: string
            example: Schenectady
          description: Origin city
        - in: query
          name: originZip
          schema:
            type: string
            example: "12345"
          description: Origin area zip
          required: true
        - in: query
          name: destinationCountry
          schema:
            type: string
            example: US
          description: |
            Destination country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: destinationState
          schema:
            type: string
            example: IL
          description: Destination state
        - in: query
          name: destinationCity
          schema:
            type: string
            example: Chicago
          description: Destination city
        - in: query
          name: destinationZip
          schema:
            type: string
            example: "60636"
          description: Destination area zip
          required: true
        - in: query
          name: hasExtraStops
          schema:
            type: boolean
            example: true
            description: |
              Signifies whether the requested lane has extra stops or not.

              If true, multistop loads will be included during calculations.
            default: false
        - in: query
          name: pickUpDateTime
          schema:
            type: string
            format: date-time
            example: "2020-01-11T16:00:00Z"
          description: PickUp date time
          required: false
        - in: query
          name: currency
          schema:
            type: string
            example: USD
          description: Code of the currency that you want the response to be in. Format is
            ISO 4217
          required: false
        - in: query
          name: region
          schema:
            type: string
            enum:
              - CITY
              - CITY_ZIP
              - ZIP_CITY
              - ZIP
              - 3DZIP
              - KMA
            description: >
              Determines the size of the area around the origin and destination
              points, 

              that will be searched for the related data.

              * CITY - narrow, city wide, area

              * ZIP - narrow, five digit zip, area

              * 3DZIP - medium, short zip, area

              * KMA - big, market wide, area

              * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

              * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
            example: ZIP
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_NegotiationResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_Error"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MarketIntelligence_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/marketintelligence/negotiation-advice',
              qs: {
                transportType: 'VAN',
                originCountry: 'US',
                originState: 'NY',
                originCity: 'Schenectady',
                originZip: '12345',
                destinationCountry: 'US',
                destinationState: 'IL',
                destinationCity: 'Chicago',
                destinationZip: '60636',
                hasExtraStops: 'true',
                pickUpDateTime: '2020-01-11T16:00:00Z',
                currency: 'USD',
                region: 'ZIP'
              },
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/marketintelligence/negotiation-advice"


            querystring = {"transportType":"VAN","originCountry":"US","originState":"NY","originCity":"Schenectady","originZip":"12345","destinationCountry":"US","destinationState":"IL","destinationCity":"Chicago","destinationZip":"60636","hasExtraStops":"true","pickUpDateTime":"2020-01-11T16:00:00Z","currency":"USD","region":"ZIP"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/marketintelligence/negotiation-advice?transportType=VAN&originCountry=US&originState=NY&originCity=Schenectady&originZip=12345&destinationCountry=US&destinationState=IL&destinationCity=Chicago&destinationZip=60636&hasExtraStops=true&pickUpDateTime=2020-01-11T16%3A00%3A00Z&currency=USD&region=ZIP",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /prediction/rates:
    post:
      tags:
        - Prediction
      summary: Lane rate prediction
      description: Used to request lane rate prediction
      security:
        - Prediction_bearerAuth: []
      operationId: predictionRates
      parameters:
        - $ref: "#/components/parameters/Prediction_UserHeader"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_PredictionRatesResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error422UnprocessableEntityMulti"
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "424":
          description: Failed Dependency.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error"
              examples:
                error424Example:
                  value:
                    code: distance_calculation_error
                    message: "Unable to calculate distance between zips {key}, reason:  {exc}"
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v3/prediction/rates',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                pickupDateTime: '2021-09-21T13:00:00Z',
                transportType: 'VAN',
                stops: [
                  {order: 0, country: 'US', city: 'Chicago', state: 'IL', zip: '60611'},
                  {order: 1, country: 'US', city: 'Dallas', state: 'TX', zip: '75204'}
                ],
                commodity: 'Racks',
                tag: 'Pro#1234',
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v3/prediction/rates"


            payload = {
                "pickupDateTime": "2021-09-21T13:00:00Z",
                "transportType": "VAN",
                "stops": [
                    {
                        "order": 0,
                        "country": "US",
                        "city": "Chicago",
                        "state": "IL",
                        "zip": "60611"
                    },
                    {
                        "order": 1,
                        "country": "US",
                        "city": "Dallas",
                        "state": "TX",
                        "zip": "75204"
                    }
                ],
                "commodity": "Racks",
                "tag": "Pro#1234",
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v3/prediction/rates",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"pickupDateTime\":\"2021-09-21T13:00:00Z\",\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"country\":\"US\",\"city\":\"Chicago\",\"state\":\"IL\",\"zip\":\"60611\"},{\"order\":1,\"country\":\"US\",\"city\":\"Dallas\",\"state\":\"TX\",\"zip\":\"75204\"}],\"commodity\":\"Racks\",\"tag\":\"Pro#1234\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v3
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v3
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v3
        description: Production server (uses live data)
  /prediction/batch-rates:
    post:
      tags:
        - Prediction
      summary: Batch lane rate prediction
      description: Used to request lane rate predictions in batches
      security:
        - Prediction_bearerAuth: []
      operationId: predictionBatchRates
      parameters:
        - $ref: "#/components/parameters/Prediction_UserHeader"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Prediction_PredictionBatchRatesRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_PredictionBatchRatesResponse"
        "400":
          $ref: "#/paths/~1prediction~1rates/post/responses/400"
        "401":
          $ref: "#/paths/~1prediction~1rates/post/responses/401"
        "403":
          $ref: "#/paths/~1prediction~1rates/post/responses/403"
        "422":
          $ref: "#/paths/~1prediction~1rates/post/responses/422"
        "424":
          $ref: "#/paths/~1prediction~1rates/post/responses/424"
        "429":
          $ref: "#/paths/~1prediction~1rates/post/responses/429"
        "500":
          $ref: "#/paths/~1prediction~1rates/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v3/prediction/batch-rates',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                requests: [
                  {
                    pickupDateTime: '2021-09-21T13:00:00Z',
                    transportType: 'VAN',
                    stops: [
                      {order: 0, country: 'US', city: 'Chicago', state: 'IL', zip: '60611'},
                      {order: 1, country: 'US', city: 'Dallas', state: 'TX', zip: '75204'}
                    ],
                    commodity: 'Racks',
                    tag: 'Pro#1234',
                    currency: 'USD'
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v3/prediction/batch-rates"


            payload = {"requests": [
                    {
                        "pickupDateTime": "2021-09-21T13:00:00Z",
                        "transportType": "VAN",
                        "stops": [
                            {
                                "order": 0,
                                "country": "US",
                                "city": "Chicago",
                                "state": "IL",
                                "zip": "60611"
                            },
                            {
                                "order": 1,
                                "country": "US",
                                "city": "Dallas",
                                "state": "TX",
                                "zip": "75204"
                            }
                        ],
                        "commodity": "Racks",
                        "tag": "Pro#1234",
                        "currency": "USD"
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v3/prediction/batch-rates",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"requests\":[{\"pickupDateTime\":\"2021-09-21T13:00:00Z\",\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"country\":\"US\",\"city\":\"Chicago\",\"state\":\"IL\",\"zip\":\"60611\"},{\"order\":1,\"country\":\"US\",\"city\":\"Dallas\",\"state\":\"TX\",\"zip\":\"75204\"}],\"commodity\":\"Racks\",\"tag\":\"Pro#1234\",\"currency\":\"USD\"}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v3
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v3
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v3
        description: Production server (uses live data)
  /prediction/history:
    get:
      tags:
        - Prediction
      summary: Lane rate prediction history
      description: >
        Lane rate prediction request/response history on the given date.

        Due to resource limitation search is restricted to the last 30 days period.

        Requests outside of this period will return 400 response code with corresponding error code.

        Results sorted from newest to oldest.
      security:
        - Prediction_bearerAuth: []
      operationId: predictionHistory
      parameters:
        - in: query
          name: date
          schema:
            type: string
            format: date
            description: All rate requests made on this day will be returned. The date must
              be within the last 30 days from today. ISO date format
              (YYYY-MM-DD).
            example: "2021-09-21"
          required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_PredictionHistoryResponse"
        "400":
          $ref: "#/paths/~1prediction~1rates/post/responses/400"
        "401":
          $ref: "#/paths/~1prediction~1rates/post/responses/401"
        "403":
          $ref: "#/paths/~1prediction~1rates/post/responses/403"
        "422":
          $ref: "#/paths/~1prediction~1rates/post/responses/422"
        "424":
          $ref: "#/paths/~1prediction~1rates/post/responses/424"
        "429":
          $ref: "#/paths/~1prediction~1rates/post/responses/429"
        "500":
          $ref: "#/paths/~1prediction~1rates/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v3/prediction/history',
              qs: {date: '2021-09-21'},
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v3/prediction/history"


            querystring = {"date":"2021-09-21"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v3/prediction/history?date=2021-09-21",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v3
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v3
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v3
        description: Production server (uses live data)
  /prediction/network-rates:
    post:
      tags:
        - Prediction
      summary: Lane network rate prediction
      description: |
        Used to request lane rate prediction based on 
        the full network of load data available to us.
      security:
        - Prediction_bearerAuth: []
      operationId: predictionNetworkRates
      parameters:
        - $ref: "#/components/parameters/Prediction_UserHeader"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_PredictionRatesResponse"
        "400":
          $ref: "#/paths/~1prediction~1rates/post/responses/400"
        "401":
          $ref: "#/paths/~1prediction~1rates/post/responses/401"
        "403":
          $ref: "#/paths/~1prediction~1rates/post/responses/403"
        "422":
          $ref: "#/paths/~1prediction~1rates/post/responses/422"
        "424":
          $ref: "#/paths/~1prediction~1rates/post/responses/424"
        "429":
          $ref: "#/paths/~1prediction~1rates/post/responses/429"
        "500":
          $ref: "#/paths/~1prediction~1rates/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v3/prediction/network-rates',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                pickupDateTime: '2021-09-21T13:00:00Z',
                transportType: 'VAN',
                stops: [
                  {order: 0, country: 'US', city: 'Chicago', state: 'IL', zip: '60611'},
                  {order: 1, country: 'US', city: 'Dallas', state: 'TX', zip: '75204'}
                ],
                commodity: 'Racks',
                tag: 'Pro#1234',
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v3/prediction/network-rates"


            payload = {
                "pickupDateTime": "2021-09-21T13:00:00Z",
                "transportType": "VAN",
                "stops": [
                    {
                        "order": 0,
                        "country": "US",
                        "city": "Chicago",
                        "state": "IL",
                        "zip": "60611"
                    },
                    {
                        "order": 1,
                        "country": "US",
                        "city": "Dallas",
                        "state": "TX",
                        "zip": "75204"
                    }
                ],
                "commodity": "Racks",
                "tag": "Pro#1234",
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v3/prediction/network-rates",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"pickupDateTime\":\"2021-09-21T13:00:00Z\",\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"country\":\"US\",\"city\":\"Chicago\",\"state\":\"IL\",\"zip\":\"60611\"},{\"order\":1,\"country\":\"US\",\"city\":\"Dallas\",\"state\":\"TX\",\"zip\":\"75204\"}],\"commodity\":\"Racks\",\"tag\":\"Pro#1234\",\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v3
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v3
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v3
        description: Production server (uses live data)
  /prediction/batch-network-rates:
    post:
      tags:
        - Prediction
      summary: Batch lane network rate prediction
      description: |
        Used to request lane rate predictions based on 
        the full network of load data available to us, in batches.
      security:
        - Prediction_bearerAuth: []
      operationId: predictionBatchNetworkRates
      parameters:
        - $ref: "#/components/parameters/Prediction_UserHeader"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Prediction_PredictionBatchRatesRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Prediction_PredictionBatchRatesResponse"
        "400":
          $ref: "#/paths/~1prediction~1rates/post/responses/400"
        "401":
          $ref: "#/paths/~1prediction~1rates/post/responses/401"
        "403":
          $ref: "#/paths/~1prediction~1rates/post/responses/403"
        "422":
          $ref: "#/paths/~1prediction~1rates/post/responses/422"
        "424":
          $ref: "#/paths/~1prediction~1rates/post/responses/424"
        "429":
          $ref: "#/paths/~1prediction~1rates/post/responses/429"
        "500":
          $ref: "#/paths/~1prediction~1rates/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v3/prediction/batch-network-rates',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                requests: [
                  {
                    pickupDateTime: '2021-09-21T13:00:00Z',
                    transportType: 'VAN',
                    stops: [
                      {order: 0, country: 'US', city: 'Chicago', state: 'IL', zip: '60611'},
                      {order: 1, country: 'US', city: 'Dallas', state: 'TX', zip: '75204'}
                    ],
                    commodity: 'Racks',
                    tag: 'Pro#1234',
                    currency: 'USD'
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v3/prediction/batch-network-rates"


            payload = {"requests": [
                    {
                        "pickupDateTime": "2021-09-21T13:00:00Z",
                        "transportType": "VAN",
                        "stops": [
                            {
                                "order": 0,
                                "country": "US",
                                "city": "Chicago",
                                "state": "IL",
                                "zip": "60611"
                            },
                            {
                                "order": 1,
                                "country": "US",
                                "city": "Dallas",
                                "state": "TX",
                                "zip": "75204"
                            }
                        ],
                        "commodity": "Racks",
                        "tag": "Pro#1234",
                        "currency": "USD"
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v3/prediction/batch-network-rates",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"requests\":[{\"pickupDateTime\":\"2021-09-21T13:00:00Z\",\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"country\":\"US\",\"city\":\"Chicago\",\"state\":\"IL\",\"zip\":\"60611\"},{\"order\":1,\"country\":\"US\",\"city\":\"Dallas\",\"state\":\"TX\",\"zip\":\"75204\"}],\"commodity\":\"Racks\",\"tag\":\"Pro#1234\",\"currency\":\"USD\"}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v3
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v3
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v3
        description: Production server (uses live data)
  /pricing/priority-rules:
    post:
      tags:
        - Pricing
      summary: Create a priority rule
      description: Create a priority rule
      operationId: pricingPriorityRulesCreate
      security:
        - Pricing_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingPriorityRuleRequest"
        required: true
      responses:
        "201":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PriorityRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/pricing/priority-rules',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                name: 'Customer`s rule',
                priority: 3,
                active: false,
                conditions: {
                  commodity: ['Apples'],
                  confidenceLevel: {from: 50, to: 250},
                  customers: ['LTR and Co', 'CocaCola', 'Walmart'],
                  lanes: [
                    {
                      origins: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ],
                      destinations: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ]
                    }
                  ],
                  lengthOfHaul: {from: 50, to: 250},
                  matchingTime: {from: 20, to: 30},
                  transitTime: {from: 20, to: 30},
                  transportTypes: ['VAN'],
                  users: ['string'],
                  weight: {from: 50, to: 250},
                  stopsCount: {from: 50, to: 250},
                  mileageDifference: {from: 50, to: 250}
                },
                effects: {
                  percentageAdjustment: {percentage: 15},
                  flatAdjustment: {amount: 15, currency: 'USD'},
                  setSellCost: {amount: 15, currency: 'USD'}
                },
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/priority-rules"


            payload = {
                "name": "Customer`s rule",
                "priority": 3,
                "active": False,
                "conditions": {
                    "commodity": ["Apples"],
                    "confidenceLevel": {
                        "from": 50,
                        "to": 250
                    },
                    "customers": ["LTR and Co", "CocaCola", "Walmart"],
                    "lanes": [
                        {
                            "origins": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ],
                            "destinations": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ]
                        }
                    ],
                    "lengthOfHaul": {
                        "from": 50,
                        "to": 250
                    },
                    "matchingTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transitTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transportTypes": ["VAN"],
                    "users": ["string"],
                    "weight": {
                        "from": 50,
                        "to": 250
                    },
                    "stopsCount": {
                        "from": 50,
                        "to": 250
                    },
                    "mileageDifference": {
                        "from": 50,
                        "to": 250
                    }
                },
                "effects": {
                    "percentageAdjustment": {"percentage": 15},
                    "flatAdjustment": {
                        "amount": 15,
                        "currency": "USD"
                    },
                    "setSellCost": {
                        "amount": 15,
                        "currency": "USD"
                    }
                },
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/priority-rules",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"name\":\"Customer`s rule\",\"priority\":3,\"active\":false,\"conditions\":{\"commodity\":[\"Apples\"],\"confidenceLevel\":{\"from\":50,\"to\":250},\"customers\":[\"LTR and Co\",\"CocaCola\",\"Walmart\"],\"lanes\":[{\"origins\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}],\"destinations\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}]}],\"lengthOfHaul\":{\"from\":50,\"to\":250},\"matchingTime\":{\"from\":20,\"to\":30},\"transitTime\":{\"from\":20,\"to\":30},\"transportTypes\":[\"VAN\"],\"users\":[\"string\"],\"weight\":{\"from\":50,\"to\":250},\"stopsCount\":{\"from\":50,\"to\":250},\"mileageDifference\":{\"from\":50,\"to\":250}},\"effects\":{\"percentageAdjustment\":{\"percentage\":15},\"flatAdjustment\":{\"amount\":15,\"currency\":\"USD\"},\"setSellCost\":{\"amount\":15,\"currency\":\"USD\"}},\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    get:
      tags:
        - Pricing
      summary: Get priority rules
      description: Get priority rules
      operationId: pricingPriorityRulesGetAll
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: query
          name: pricingTypeGroup
          schema:
            type: string
            description: Pricing rule group filter. If not specified, all rules are
              returned.
            enum:
              - SPOT
              - CONTRACT
          required: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PricingPriorityRulesResponse"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/pricing/priority-rules',
              qs: {pricingTypeGroup: 'SOME_STRING_VALUE'},
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/priority-rules"


            querystring = {"pricingTypeGroup":"SOME_STRING_VALUE"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/priority-rules?pricingTypeGroup=SOME_STRING_VALUE",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  "/pricing/priority-rules/{ruleId}":
    get:
      tags:
        - Pricing
      summary: Get a priority rule
      description: Get a priority rule
      operationId: pricingPriorityRuleGet
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the priority rule to get
          schema:
            type: integer
            format: int64
            example: 12345
          required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PriorityRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D',
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D"


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    put:
      tags:
        - Pricing
      summary: Update a priority rule
      description: Update a priority rule
      operationId: pricingPriorityRuleUpdate
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the priority rule to update
          required: true
          schema:
            type: integer
            format: int64
            example: 12345
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingPriorityRuleRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PriorityRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'PUT',
              url: 'https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                name: 'Customer`s rule',
                priority: 3,
                active: false,
                conditions: {
                  commodity: ['Apples'],
                  confidenceLevel: {from: 50, to: 250},
                  customers: ['LTR and Co', 'CocaCola', 'Walmart'],
                  lanes: [
                    {
                      origins: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ],
                      destinations: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ]
                    }
                  ],
                  lengthOfHaul: {from: 50, to: 250},
                  matchingTime: {from: 20, to: 30},
                  transitTime: {from: 20, to: 30},
                  transportTypes: ['VAN'],
                  users: ['string'],
                  weight: {from: 50, to: 250},
                  stopsCount: {from: 50, to: 250},
                  mileageDifference: {from: 50, to: 250}
                },
                effects: {
                  percentageAdjustment: {percentage: 15},
                  flatAdjustment: {amount: 15, currency: 'USD'},
                  setSellCost: {amount: 15, currency: 'USD'}
                },
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D"


            payload = {
                "name": "Customer`s rule",
                "priority": 3,
                "active": False,
                "conditions": {
                    "commodity": ["Apples"],
                    "confidenceLevel": {
                        "from": 50,
                        "to": 250
                    },
                    "customers": ["LTR and Co", "CocaCola", "Walmart"],
                    "lanes": [
                        {
                            "origins": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ],
                            "destinations": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ]
                        }
                    ],
                    "lengthOfHaul": {
                        "from": 50,
                        "to": 250
                    },
                    "matchingTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transitTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transportTypes": ["VAN"],
                    "users": ["string"],
                    "weight": {
                        "from": 50,
                        "to": 250
                    },
                    "stopsCount": {
                        "from": 50,
                        "to": 250
                    },
                    "mileageDifference": {
                        "from": 50,
                        "to": 250
                    }
                },
                "effects": {
                    "percentageAdjustment": {"percentage": 15},
                    "flatAdjustment": {
                        "amount": 15,
                        "currency": "USD"
                    },
                    "setSellCost": {
                        "amount": 15,
                        "currency": "USD"
                    }
                },
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("PUT", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "PUT",
              CURLOPT_POSTFIELDS => "{\"name\":\"Customer`s rule\",\"priority\":3,\"active\":false,\"conditions\":{\"commodity\":[\"Apples\"],\"confidenceLevel\":{\"from\":50,\"to\":250},\"customers\":[\"LTR and Co\",\"CocaCola\",\"Walmart\"],\"lanes\":[{\"origins\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}],\"destinations\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}]}],\"lengthOfHaul\":{\"from\":50,\"to\":250},\"matchingTime\":{\"from\":20,\"to\":30},\"transitTime\":{\"from\":20,\"to\":30},\"transportTypes\":[\"VAN\"],\"users\":[\"string\"],\"weight\":{\"from\":50,\"to\":250},\"stopsCount\":{\"from\":50,\"to\":250},\"mileageDifference\":{\"from\":50,\"to\":250}},\"effects\":{\"percentageAdjustment\":{\"percentage\":15},\"flatAdjustment\":{\"amount\":15,\"currency\":\"USD\"},\"setSellCost\":{\"amount\":15,\"currency\":\"USD\"}},\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    delete:
      tags:
        - Pricing
      summary: Delete a priority rule
      description: Delete a priority rule
      operationId: pricingPriorityRuleDelete
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the priority rule to delete
          schema:
            type: integer
            format: int64
            example: 12345
          required: true
      responses:
        "204":
          description: Success
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'DELETE',
              url: 'https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D',
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D"


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("DELETE", url, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/priority-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "DELETE",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /pricing/combination-rules:
    post:
      tags:
        - Pricing
      summary: Create a combination rule
      description: Create a combination rule
      operationId: pricingCombinationRuleCreate
      security:
        - Pricing_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingCombinationRuleRequest"
        required: true
      responses:
        "201":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_CombinationRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/pricing/combination-rules',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                name: 'Customer`s rule',
                active: false,
                conditions: {
                  commodity: ['Apples'],
                  confidenceLevel: {from: 50, to: 250},
                  customers: ['LTR and Co', 'CocaCola', 'Walmart'],
                  lanes: [
                    {
                      origins: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ],
                      destinations: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ]
                    }
                  ],
                  lengthOfHaul: {from: 50, to: 250},
                  matchingTime: {from: 20, to: 30},
                  transitTime: {from: 20, to: 30},
                  transportTypes: ['VAN'],
                  users: ['string'],
                  weight: {from: 50, to: 250},
                  stopsCount: {from: 50, to: 250},
                  mileageDifference: {from: 50, to: 250}
                },
                effects: {
                  percentageAdjustment: {percentage: 15},
                  flatAdjustment: {amount: 15, currency: 'USD'}
                },
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/combination-rules"


            payload = {
                "name": "Customer`s rule",
                "active": False,
                "conditions": {
                    "commodity": ["Apples"],
                    "confidenceLevel": {
                        "from": 50,
                        "to": 250
                    },
                    "customers": ["LTR and Co", "CocaCola", "Walmart"],
                    "lanes": [
                        {
                            "origins": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ],
                            "destinations": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ]
                        }
                    ],
                    "lengthOfHaul": {
                        "from": 50,
                        "to": 250
                    },
                    "matchingTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transitTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transportTypes": ["VAN"],
                    "users": ["string"],
                    "weight": {
                        "from": 50,
                        "to": 250
                    },
                    "stopsCount": {
                        "from": 50,
                        "to": 250
                    },
                    "mileageDifference": {
                        "from": 50,
                        "to": 250
                    }
                },
                "effects": {
                    "percentageAdjustment": {"percentage": 15},
                    "flatAdjustment": {
                        "amount": 15,
                        "currency": "USD"
                    }
                },
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/combination-rules",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"name\":\"Customer`s rule\",\"active\":false,\"conditions\":{\"commodity\":[\"Apples\"],\"confidenceLevel\":{\"from\":50,\"to\":250},\"customers\":[\"LTR and Co\",\"CocaCola\",\"Walmart\"],\"lanes\":[{\"origins\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}],\"destinations\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}]}],\"lengthOfHaul\":{\"from\":50,\"to\":250},\"matchingTime\":{\"from\":20,\"to\":30},\"transitTime\":{\"from\":20,\"to\":30},\"transportTypes\":[\"VAN\"],\"users\":[\"string\"],\"weight\":{\"from\":50,\"to\":250},\"stopsCount\":{\"from\":50,\"to\":250},\"mileageDifference\":{\"from\":50,\"to\":250}},\"effects\":{\"percentageAdjustment\":{\"percentage\":15},\"flatAdjustment\":{\"amount\":15,\"currency\":\"USD\"}},\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    get:
      tags:
        - Pricing
      summary: Get combination rules
      description: Get combination rules
      operationId: pricingCombinationRulesGetAll
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: query
          name: pricingTypeGroup
          schema:
            type: string
            description: Pricing rule group filter. If not specified, all rules are
              returned.
            enum:
              - SPOT
              - CONTRACT
          required: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PricingCombinationRulesResponse"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/pricing/combination-rules',
              qs: {pricingTypeGroup: 'SOME_STRING_VALUE'},
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/combination-rules"


            querystring = {"pricingTypeGroup":"SOME_STRING_VALUE"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/combination-rules?pricingTypeGroup=SOME_STRING_VALUE",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  "/pricing/combination-rules/{ruleId}":
    get:
      tags:
        - Pricing
      summary: Get a combination rule
      description: Get a combination rule
      operationId: pricingCombinationRuleGet
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the combination rule to get
          schema:
            type: integer
            format: int64
            example: 12345
          required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_CombinationRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D',
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D"


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    put:
      tags:
        - Pricing
      summary: Update a combination rule
      description: Update a combination rule
      operationId: pricingCombinationRuleUpdate
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the combination rule to update
          required: true
          schema:
            type: integer
            format: int64
            example: 12345
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingCombinationRuleRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_CombinationRule"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'PUT',
              url: 'https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                name: 'Customer`s rule',
                active: false,
                conditions: {
                  commodity: ['Apples'],
                  confidenceLevel: {from: 50, to: 250},
                  customers: ['LTR and Co', 'CocaCola', 'Walmart'],
                  lanes: [
                    {
                      origins: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ],
                      destinations: [
                        {type: 'ANYWHERE'},
                        {type: 'STATE', country: 'US', state: 'IL'},
                        {type: 'CITY', country: 'US', state: 'IL', city: 'Chicago'},
                        {type: 'MARKET', country: 'US', marketCode: 'NY_ALB'}
                      ]
                    }
                  ],
                  lengthOfHaul: {from: 50, to: 250},
                  matchingTime: {from: 20, to: 30},
                  transitTime: {from: 20, to: 30},
                  transportTypes: ['VAN'],
                  users: ['string'],
                  weight: {from: 50, to: 250},
                  stopsCount: {from: 50, to: 250},
                  mileageDifference: {from: 50, to: 250}
                },
                effects: {
                  percentageAdjustment: {percentage: 15},
                  flatAdjustment: {amount: 15, currency: 'USD'}
                },
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D"


            payload = {
                "name": "Customer`s rule",
                "active": False,
                "conditions": {
                    "commodity": ["Apples"],
                    "confidenceLevel": {
                        "from": 50,
                        "to": 250
                    },
                    "customers": ["LTR and Co", "CocaCola", "Walmart"],
                    "lanes": [
                        {
                            "origins": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ],
                            "destinations": [
                                {"type": "ANYWHERE"},
                                {
                                    "type": "STATE",
                                    "country": "US",
                                    "state": "IL"
                                },
                                {
                                    "type": "CITY",
                                    "country": "US",
                                    "state": "IL",
                                    "city": "Chicago"
                                },
                                {
                                    "type": "MARKET",
                                    "country": "US",
                                    "marketCode": "NY_ALB"
                                }
                            ]
                        }
                    ],
                    "lengthOfHaul": {
                        "from": 50,
                        "to": 250
                    },
                    "matchingTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transitTime": {
                        "from": 20,
                        "to": 30
                    },
                    "transportTypes": ["VAN"],
                    "users": ["string"],
                    "weight": {
                        "from": 50,
                        "to": 250
                    },
                    "stopsCount": {
                        "from": 50,
                        "to": 250
                    },
                    "mileageDifference": {
                        "from": 50,
                        "to": 250
                    }
                },
                "effects": {
                    "percentageAdjustment": {"percentage": 15},
                    "flatAdjustment": {
                        "amount": 15,
                        "currency": "USD"
                    }
                },
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("PUT", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "PUT",
              CURLOPT_POSTFIELDS => "{\"name\":\"Customer`s rule\",\"active\":false,\"conditions\":{\"commodity\":[\"Apples\"],\"confidenceLevel\":{\"from\":50,\"to\":250},\"customers\":[\"LTR and Co\",\"CocaCola\",\"Walmart\"],\"lanes\":[{\"origins\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}],\"destinations\":[{\"type\":\"ANYWHERE\"},{\"type\":\"STATE\",\"country\":\"US\",\"state\":\"IL\"},{\"type\":\"CITY\",\"country\":\"US\",\"state\":\"IL\",\"city\":\"Chicago\"},{\"type\":\"MARKET\",\"country\":\"US\",\"marketCode\":\"NY_ALB\"}]}],\"lengthOfHaul\":{\"from\":50,\"to\":250},\"matchingTime\":{\"from\":20,\"to\":30},\"transitTime\":{\"from\":20,\"to\":30},\"transportTypes\":[\"VAN\"],\"users\":[\"string\"],\"weight\":{\"from\":50,\"to\":250},\"stopsCount\":{\"from\":50,\"to\":250},\"mileageDifference\":{\"from\":50,\"to\":250}},\"effects\":{\"percentageAdjustment\":{\"percentage\":15},\"flatAdjustment\":{\"amount\":15,\"currency\":\"USD\"}},\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    delete:
      tags:
        - Pricing
      summary: Delete a combination rule
      description: Delete a combination rule
      operationId: pricingCombinationRuleDelete
      security:
        - Pricing_bearerAuth: []
      parameters:
        - in: path
          name: ruleId
          description: Id of the combination rule to delete
          schema:
            type: integer
            format: int64
            example: 12345
          required: true
      responses:
        "204":
          description: Success
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "403":
          $ref: "#/paths/~1pricing~1priority-rules/get/responses/403"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'DELETE',
              url: 'https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D',
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D"


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("DELETE", url, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/combination-rules/%7BruleId%7D",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "DELETE",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /pricing/tpl-pricing:
    post:
      tags:
        - Pricing
      summary: Calculate pricing, based on TPL data
      description: >
        Returns all pricing suggestions: statistical, rule related, etc. 

        intended for TPL pricing and calculated using TPL data.


        Most of the fields in the request and response are optional.


        Response fields are related to request fields e.g. if you do not provide

        the customer name in the request, there will be no customer related

        pricing data in the response, and the pricing rules that use customer name predicates

        will not be found.


        To get the most possible data in the response, provide all the data you can 

        in the request. However if for example you only need customer related pricing data,

        you can provide only the customer name in the request.


        Also note that if providing addresses, 

        origin and destination country is required.

        The state code can be provided without city and zip, 

        and the city name can be provided without a zip code,

        and the zip code can be provided without a city or a state.

        This will also affect what kind of rules are found and what statistical data

        is calculated and returned.


        Parameter notes:

        * __region__ - defaults to ZIP if not provided
      operationId: pricingTplPricing
      security:
        - Pricing_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PricingResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error422UnprocessableEntityMulti"
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "424":
          description: Failed Dependency.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error424Example:
                  value:
                    code: distance_calculation_error
                    message: "Unable to calculate distance between zips {key}, reason:  {exc}"
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/pricing/tpl-pricing',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                transportType: 'VAN',
                stops: [
                  {
                    order: 0,
                    address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'}
                  },
                  {order: 1, address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'}}
                ],
                region: 'ZIP',
                customerName: 'Test Customer',
                pickupDate: '2020-01-13T16:00:00Z',
                deliveryDate: '2020-01-13T16:00:00Z',
                weight: 10000,
                commodity: 'Apples',
                targetBuyCost: 1000,
                confidenceLevel: 65,
                currency: 'USD',
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/tpl-pricing"


            payload = {
                "transportType": "VAN",
                "stops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "city": "Red Bluff",
                            "state": "CA",
                            "zip": "96080"
                        }
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA",
                            "zip": "96002"
                        }
                    }
                ],
                "region": "ZIP",
                "customerName": "Test Customer",
                "pickupDate": "2020-01-13T16:00:00Z",
                "deliveryDate": "2020-01-13T16:00:00Z",
                "weight": 10000,
                "commodity": "Apples",
                "targetBuyCost": 1000,
                "confidenceLevel": 65,
                "currency": "USD",
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/tpl-pricing",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"}},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"}}],\"region\":\"ZIP\",\"customerName\":\"Test Customer\",\"pickupDate\":\"2020-01-13T16:00:00Z\",\"deliveryDate\":\"2020-01-13T16:00:00Z\",\"weight\":10000,\"commodity\":\"Apples\",\"targetBuyCost\":1000,\"confidenceLevel\":65,\"currency\":\"USD\",\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /pricing/marketplace/my-broker-partners:
    post:
      tags:
        - Pricing
      summary: Get sell rates of partner brokers
      description: |
        Intended to be used by a shipper-broker marketplace (a.k.a Shipper TMS).

        Returns a list of brokers that confirmed that they want to work with
        the marketplace that is requesting the rates.

        Each broker in the list will contain a sell rate that they are
        willing to move the load for
      operationId: pricingMarketplaceMyBrokerPartners
      security:
        - Pricing_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pricing_PricingMarketplaceMyBrokerPartnersRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pricing_PricingMarketplaceMyBrokerPartnersResponse"
        "400":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/400"
        "401":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/401"
        "404":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/404"
        "422":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/422"
        "424":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/424"
        "429":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/429"
        "500":
          $ref: "#/paths/~1pricing~1tpl-pricing/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v1/pricing/marketplace/my-broker-partners',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                transportType: 'VAN',
                stops: [
                  {
                    order: 0,
                    address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'}
                  },
                  {order: 1, address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'}}
                ],
                region: 'ZIP',
                customerName: 'Test Customer',
                pickupDate: '2020-01-13T16:00:00Z',
                deliveryDate: '2020-01-13T16:00:00Z',
                weight: 10000,
                commodity: 'Apples',
                currency: 'USD',
                pricingTypeGroup: 'SPOT'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v1/pricing/marketplace/my-broker-partners"


            payload = {
                "transportType": "VAN",
                "stops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "city": "Red Bluff",
                            "state": "CA",
                            "zip": "96080"
                        }
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA",
                            "zip": "96002"
                        }
                    }
                ],
                "region": "ZIP",
                "customerName": "Test Customer",
                "pickupDate": "2020-01-13T16:00:00Z",
                "deliveryDate": "2020-01-13T16:00:00Z",
                "weight": 10000,
                "commodity": "Apples",
                "currency": "USD",
                "pricingTypeGroup": "SPOT"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v1/pricing/marketplace/my-broker-partners",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"transportType\":\"VAN\",\"stops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"}},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"}}],\"region\":\"ZIP\",\"customerName\":\"Test Customer\",\"pickupDate\":\"2020-01-13T16:00:00Z\",\"deliveryDate\":\"2020-01-13T16:00:00Z\",\"weight\":10000,\"commodity\":\"Apples\",\"currency\":\"USD\",\"pricingTypeGroup\":\"SPOT\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v1
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v1
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v1
        description: Production server (uses live data)
  /quotes:
    get:
      tags:
        - Quotes
      summary: Get quotes
      description: Get quotes
      operationId: quotesGetAll
      security:
        - Quotes_bearerAuth: []
      parameters:
        - in: query
          name: createdDateFrom
          description: \'quote created date >= value\' filter
          schema:
            type: string
            format: date
            example: "2019-09-30"
        - in: query
          name: createdDateTo
          description: \'quote created date <= value\' filter
          schema:
            type: string
            format: date
            example: "2019-12-30"
        - in: query
          name: page
          description: |
            The page to return items from. 
            Used for pagination
          schema:
            type: integer
            minimum: 0
            default: 0
            example: 5
        - in: query
          name: perPage
          description: |
            The amount of items per page. 
            Used for pagination
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 20
            example: 30
        - in: query
          name: currency
          schema:
            type: string
            enum:
              - USD
              - CAD
            description: >
              Currency code in ISO 4217 format (three letter code, e.g. USD)


              _If not provided, defaults to the currency set in the profile 

              of currently authenticated user (or currently authenticated company 

              if there is no user or user profile setting)_
            example: USD
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_QuotesResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error422UnprocessableEntityMulti"
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: |
            const request = require('request');

            const options = {
              method: 'GET',
              url: 'https://testapi.greenscreens.ai/v2/quotes',
              qs: {
                createdDateFrom: '2019-09-30',
                createdDateTo: '2019-12-30',
                page: '5',
                perPage: '30',
                currency: 'USD'
              },
              headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
            };

            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/quotes"


            querystring = {"createdDateFrom":"2019-09-30","createdDateTo":"2019-12-30","page":"5","perPage":"30","currency":"USD"}


            headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}


            response = requests.request("GET", url, headers=headers, params=querystring)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/quotes?createdDateFrom=2019-09-30&createdDateTo=2019-12-30&page=5&perPage=30&currency=USD",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /quotes/import:
    post:
      tags:
        - Quotes
      summary: Import a quote
      description: Import an external quote
      operationId: quotesImport
      security:
        - Quotes_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Quotes_QuotesImportRequest"
        required: true
      responses:
        "201":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_QuotesImportResponse"
        "400":
          $ref: "#/paths/~1quotes/get/responses/400"
        "401":
          $ref: "#/paths/~1quotes/get/responses/401"
        "403":
          $ref: "#/paths/~1quotes/get/responses/403"
        "422":
          $ref: "#/paths/~1quotes/get/responses/422"
        "429":
          $ref: "#/paths/~1quotes/get/responses/429"
        "500":
          $ref: "#/paths/~1quotes/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/quotes/import',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                quoteId: 'Q#54321',
                loadId: '12345',
                userEmail: 'buddy@greenscreens.ai',
                transportType: 'VR',
                transportTypeGroup: 'VAN',
                stops: [
                  {
                    order: 0,
                    address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'},
                    type: 'LOAD',
                    appointmentDateTime: '2020-10-13T16:00:00Z'
                  },
                  {
                    order: 1,
                    address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'},
                    type: 'UNLOAD',
                    appointmentDateTime: '2020-10-14T16:00:00Z'
                  }
                ],
                distance: 289,
                pickupDateTime: '2020-10-13T16:00:00Z',
                deliveredDateTime: '2020-10-14T16:00:00Z',
                expirationDateTime: '2020-10-12T16:00:00+05:00',
                quoteDateTime: '2020-10-13T16:00:00Z',
                status: 'WON',
                rejectionReason: 'Rejecting, because price is too high',
                weight: 22000,
                shipper: {
                  id: '64378901',
                  name: 'Walmart',
                  phone: '4112228888',
                  email: 'test@greenscreens.ai'
                },
                pricingType: 'SPOT',
                pricingTypeGroup: 'SPOT',
                contractDuration: 5,
                numberOfLoads: 10,
                costs: {linehaul: 1200, accessorials: [{name: 'Overweight', cost: 200.5}], total: 1500},
                currency: 'USD'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/quotes/import"


            payload = {
                "quoteId": "Q#54321",
                "loadId": "12345",
                "userEmail": "buddy@greenscreens.ai",
                "transportType": "VR",
                "transportTypeGroup": "VAN",
                "stops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "city": "Red Bluff",
                            "state": "CA",
                            "zip": "96080"
                        },
                        "type": "LOAD",
                        "appointmentDateTime": "2020-10-13T16:00:00Z"
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA",
                            "zip": "96002"
                        },
                        "type": "UNLOAD",
                        "appointmentDateTime": "2020-10-14T16:00:00Z"
                    }
                ],
                "distance": 289,
                "pickupDateTime": "2020-10-13T16:00:00Z",
                "deliveredDateTime": "2020-10-14T16:00:00Z",
                "expirationDateTime": "2020-10-12T16:00:00+05:00",
                "quoteDateTime": "2020-10-13T16:00:00Z",
                "status": "WON",
                "rejectionReason": "Rejecting, because price is too high",
                "weight": 22000,
                "shipper": {
                    "id": "64378901",
                    "name": "Walmart",
                    "phone": "4112228888",
                    "email": "test@greenscreens.ai"
                },
                "pricingType": "SPOT",
                "pricingTypeGroup": "SPOT",
                "contractDuration": 5,
                "numberOfLoads": 10,
                "costs": {
                    "linehaul": 1200,
                    "accessorials": [
                        {
                            "name": "Overweight",
                            "cost": 200.5
                        }
                    ],
                    "total": 1500
                },
                "currency": "USD"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/quotes/import",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"quoteId\":\"Q#54321\",\"loadId\":\"12345\",\"userEmail\":\"buddy@greenscreens.ai\",\"transportType\":\"VR\",\"transportTypeGroup\":\"VAN\",\"stops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-13T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"}],\"distance\":289,\"pickupDateTime\":\"2020-10-13T16:00:00Z\",\"deliveredDateTime\":\"2020-10-14T16:00:00Z\",\"expirationDateTime\":\"2020-10-12T16:00:00+05:00\",\"quoteDateTime\":\"2020-10-13T16:00:00Z\",\"status\":\"WON\",\"rejectionReason\":\"Rejecting, because price is too high\",\"weight\":22000,\"shipper\":{\"id\":\"64378901\",\"name\":\"Walmart\",\"phone\":\"4112228888\",\"email\":\"test@greenscreens.ai\"},\"pricingType\":\"SPOT\",\"pricingTypeGroup\":\"SPOT\",\"contractDuration\":5,\"numberOfLoads\":10,\"costs\":{\"linehaul\":1200,\"accessorials\":[{\"name\":\"Overweight\",\"cost\":200.5}],\"total\":1500},\"currency\":\"USD\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /quotes/batch/import:
    post:
      tags:
        - Quotes
      summary: Import quotes in a batch
      description: Import quotes in a batch
      operationId: quotesBatchImport
      security:
        - Quotes_bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Quotes_QuotesBatchImportRequest"
        required: true
      responses:
        "201":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Quotes_QuotesBatchImportResponse"
        "400":
          $ref: "#/paths/~1quotes/get/responses/400"
        "401":
          $ref: "#/paths/~1quotes/get/responses/401"
        "403":
          $ref: "#/paths/~1quotes/get/responses/403"
        "422":
          $ref: "#/paths/~1quotes/get/responses/422"
        "429":
          $ref: "#/paths/~1quotes/get/responses/429"
        "500":
          $ref: "#/paths/~1quotes/get/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/quotes/batch/import',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                quotes: [
                  {
                    quoteId: 'Q#54321',
                    loadId: '12345',
                    userEmail: 'buddy@greenscreens.ai',
                    transportType: 'VR',
                    transportTypeGroup: 'VAN',
                    stops: [
                      {
                        order: 0,
                        address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'},
                        type: 'LOAD',
                        appointmentDateTime: '2020-10-13T16:00:00Z'
                      },
                      {
                        order: 1,
                        address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'},
                        type: 'UNLOAD',
                        appointmentDateTime: '2020-10-14T16:00:00Z'
                      }
                    ],
                    distance: 289,
                    pickupDateTime: '2020-10-13T16:00:00Z',
                    deliveredDateTime: '2020-10-14T16:00:00Z',
                    expirationDateTime: '2020-10-12T16:00:00+05:00',
                    quoteDateTime: '2020-10-13T16:00:00Z',
                    status: 'WON',
                    rejectionReason: 'Rejecting, because price is too high',
                    weight: 22000,
                    shipper: {
                      id: '64378901',
                      name: 'Walmart',
                      phone: '4112228888',
                      email: 'test@greenscreens.ai'
                    },
                    pricingType: 'SPOT',
                    pricingTypeGroup: 'SPOT',
                    contractDuration: 5,
                    numberOfLoads: 10,
                    costs: {linehaul: 1200, accessorials: [{name: 'Overweight', cost: 200.5}], total: 1500},
                    currency: 'USD'
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/quotes/batch/import"


            payload = {"quotes": [
                    {
                        "quoteId": "Q#54321",
                        "loadId": "12345",
                        "userEmail": "buddy@greenscreens.ai",
                        "transportType": "VR",
                        "transportTypeGroup": "VAN",
                        "stops": [
                            {
                                "order": 0,
                                "address": {
                                    "country": "US",
                                    "city": "Red Bluff",
                                    "state": "CA",
                                    "zip": "96080"
                                },
                                "type": "LOAD",
                                "appointmentDateTime": "2020-10-13T16:00:00Z"
                            },
                            {
                                "order": 1,
                                "address": {
                                    "country": "US",
                                    "city": "Redding",
                                    "state": "CA",
                                    "zip": "96002"
                                },
                                "type": "UNLOAD",
                                "appointmentDateTime": "2020-10-14T16:00:00Z"
                            }
                        ],
                        "distance": 289,
                        "pickupDateTime": "2020-10-13T16:00:00Z",
                        "deliveredDateTime": "2020-10-14T16:00:00Z",
                        "expirationDateTime": "2020-10-12T16:00:00+05:00",
                        "quoteDateTime": "2020-10-13T16:00:00Z",
                        "status": "WON",
                        "rejectionReason": "Rejecting, because price is too high",
                        "weight": 22000,
                        "shipper": {
                            "id": "64378901",
                            "name": "Walmart",
                            "phone": "4112228888",
                            "email": "test@greenscreens.ai"
                        },
                        "pricingType": "SPOT",
                        "pricingTypeGroup": "SPOT",
                        "contractDuration": 5,
                        "numberOfLoads": 10,
                        "costs": {
                            "linehaul": 1200,
                            "accessorials": [
                                {
                                    "name": "Overweight",
                                    "cost": 200.5
                                }
                            ],
                            "total": 1500
                        },
                        "currency": "USD"
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/quotes/batch/import",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"quotes\":[{\"quoteId\":\"Q#54321\",\"loadId\":\"12345\",\"userEmail\":\"buddy@greenscreens.ai\",\"transportType\":\"VR\",\"transportTypeGroup\":\"VAN\",\"stops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-13T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"}],\"distance\":289,\"pickupDateTime\":\"2020-10-13T16:00:00Z\",\"deliveredDateTime\":\"2020-10-14T16:00:00Z\",\"expirationDateTime\":\"2020-10-12T16:00:00+05:00\",\"quoteDateTime\":\"2020-10-13T16:00:00Z\",\"status\":\"WON\",\"rejectionReason\":\"Rejecting, because price is too high\",\"weight\":22000,\"shipper\":{\"id\":\"64378901\",\"name\":\"Walmart\",\"phone\":\"4112228888\",\"email\":\"test@greenscreens.ai\"},\"pricingType\":\"SPOT\",\"pricingTypeGroup\":\"SPOT\",\"contractDuration\":5,\"numberOfLoads\":10,\"costs\":{\"linehaul\":1200,\"accessorials\":[{\"name\":\"Overweight\",\"cost\":200.5}],\"total\":1500},\"currency\":\"USD\"}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/import-load:
    post:
      tags:
        - TMS
      summary: Import load
      security:
        - TmsConnector_bearerAuth: []
      description: Import a new load or update an existing one
      operationId: tmsImportLoad
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_ImportLoadRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_ImportLoadResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error"
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error422UnprocessableEntityMulti"
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/import-load',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                loadId: '12345',
                origin: {
                  country: 'US',
                  city: 'Sacramento',
                  state: 'CA',
                  zip: '95814',
                  appointmentDateTime: '2020-10-13T09:00:00Z',
                  scheduledAppointmentStartedAt: '2020-10-13T09:00:00Z',
                  scheduledAppointmentEndedAt: '2020-10-13T11:00:00Z',
                  arrivedAt: '2020-10-13T09:15:00Z',
                  departedAt: '2020-10-13T10:45:00Z'
                },
                destination: {
                  country: 'US',
                  city: 'Sacramento',
                  state: 'CA',
                  zip: '95814',
                  appointmentDateTime: '2020-10-13T09:00:00Z',
                  scheduledAppointmentStartedAt: '2020-10-13T09:00:00Z',
                  scheduledAppointmentEndedAt: '2020-10-13T11:00:00Z',
                  arrivedAt: '2020-10-13T09:15:00Z',
                  departedAt: '2020-10-13T10:45:00Z'
                },
                extraStops: [
                  {
                    order: 0,
                    address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'},
                    type: 'LOAD',
                    appointmentDateTime: '2020-10-14T16:00:00Z'
                  },
                  {
                    order: 1,
                    address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'},
                    type: 'UNLOAD',
                    appointmentDateTime: '2020-10-15T16:00:00Z'
                  }
                ],
                rate: {
                  totalShipperLinehaulCost: 1176,
                  totalLinehaulCost: 956,
                  totalFuelCost: 45,
                  accessorials: [{name: 'Overweight', shipperCost: 200, carrierCost: 0}],
                  totalShipperCost: 1276,
                  totalCarrierCost: 1130,
                  currency: 'USD'
                },
                pickupDate: '2021-09-21T13:00:00-04:00',
                deliveredDate: '2021-09-22T18:00:00-04:00',
                transportType: 'VR',
                transportTypeGroup: 'VAN',
                transportMode: 'FTL',
                status: 'OPEN',
                details: {
                  distance: 434,
                  miles: 434,
                  commodity: 'Racks',
                  weight: 22000,
                  tenderedDate: '2020-01-11T16:00:00Z',
                  bookedDate: '2020-01-11T16:00:00Z',
                  tordFlag: false,
                  hazmat: false,
                  hotshot: false,
                  teamDrive: false,
                  overdimensional: false,
                  dedicatedCarrierContract: false,
                  asset: false,
                  pricingType: 'Spot',
                  pricingTypeGroup: 'SPOT',
                  carrierAccountManager: 'John Doe',
                  shipperAccountManager: 'John Doe',
                  salesManager: 'John Doe',
                  userGroupId: 'Main office',
                  office: 'Main office'
                },
                shipper: {id: '12345', name: 'Shipper company'},
                carrier: {id: '12345', name: 'Carrier company'}
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/import-load"


            payload = {
                "loadId": "12345",
                "origin": {
                    "country": "US",
                    "city": "Sacramento",
                    "state": "CA",
                    "zip": "95814",
                    "appointmentDateTime": "2020-10-13T09:00:00Z",
                    "scheduledAppointmentStartedAt": "2020-10-13T09:00:00Z",
                    "scheduledAppointmentEndedAt": "2020-10-13T11:00:00Z",
                    "arrivedAt": "2020-10-13T09:15:00Z",
                    "departedAt": "2020-10-13T10:45:00Z"
                },
                "destination": {
                    "country": "US",
                    "city": "Sacramento",
                    "state": "CA",
                    "zip": "95814",
                    "appointmentDateTime": "2020-10-13T09:00:00Z",
                    "scheduledAppointmentStartedAt": "2020-10-13T09:00:00Z",
                    "scheduledAppointmentEndedAt": "2020-10-13T11:00:00Z",
                    "arrivedAt": "2020-10-13T09:15:00Z",
                    "departedAt": "2020-10-13T10:45:00Z"
                },
                "extraStops": [
                    {
                        "order": 0,
                        "address": {
                            "country": "US",
                            "city": "Red Bluff",
                            "state": "CA",
                            "zip": "96080"
                        },
                        "type": "LOAD",
                        "appointmentDateTime": "2020-10-14T16:00:00Z"
                    },
                    {
                        "order": 1,
                        "address": {
                            "country": "US",
                            "city": "Redding",
                            "state": "CA",
                            "zip": "96002"
                        },
                        "type": "UNLOAD",
                        "appointmentDateTime": "2020-10-15T16:00:00Z"
                    }
                ],
                "rate": {
                    "totalShipperLinehaulCost": 1176,
                    "totalLinehaulCost": 956,
                    "totalFuelCost": 45,
                    "accessorials": [
                        {
                            "name": "Overweight",
                            "shipperCost": 200,
                            "carrierCost": 0
                        }
                    ],
                    "totalShipperCost": 1276,
                    "totalCarrierCost": 1130,
                    "currency": "USD"
                },
                "pickupDate": "2021-09-21T13:00:00-04:00",
                "deliveredDate": "2021-09-22T18:00:00-04:00",
                "transportType": "VR",
                "transportTypeGroup": "VAN",
                "transportMode": "FTL",
                "status": "OPEN",
                "details": {
                    "distance": 434,
                    "miles": 434,
                    "commodity": "Racks",
                    "weight": 22000,
                    "tenderedDate": "2020-01-11T16:00:00Z",
                    "bookedDate": "2020-01-11T16:00:00Z",
                    "tordFlag": False,
                    "hazmat": False,
                    "hotshot": False,
                    "teamDrive": False,
                    "overdimensional": False,
                    "dedicatedCarrierContract": False,
                    "asset": False,
                    "pricingType": "Spot",
                    "pricingTypeGroup": "SPOT",
                    "carrierAccountManager": "John Doe",
                    "shipperAccountManager": "John Doe",
                    "salesManager": "John Doe",
                    "userGroupId": "Main office",
                    "office": "Main office"
                },
                "shipper": {
                    "id": "12345",
                    "name": "Shipper company"
                },
                "carrier": {
                    "id": "12345",
                    "name": "Carrier company"
                }
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/import-load",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"loadId\":\"12345\",\"origin\":{\"country\":\"US\",\"city\":\"Sacramento\",\"state\":\"CA\",\"zip\":\"95814\",\"appointmentDateTime\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentStartedAt\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentEndedAt\":\"2020-10-13T11:00:00Z\",\"arrivedAt\":\"2020-10-13T09:15:00Z\",\"departedAt\":\"2020-10-13T10:45:00Z\"},\"destination\":{\"country\":\"US\",\"city\":\"Sacramento\",\"state\":\"CA\",\"zip\":\"95814\",\"appointmentDateTime\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentStartedAt\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentEndedAt\":\"2020-10-13T11:00:00Z\",\"arrivedAt\":\"2020-10-13T09:15:00Z\",\"departedAt\":\"2020-10-13T10:45:00Z\"},\"extraStops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-15T16:00:00Z\"}],\"rate\":{\"totalShipperLinehaulCost\":1176,\"totalLinehaulCost\":956,\"totalFuelCost\":45,\"accessorials\":[{\"name\":\"Overweight\",\"shipperCost\":200,\"carrierCost\":0}],\"totalShipperCost\":1276,\"totalCarrierCost\":1130,\"currency\":\"USD\"},\"pickupDate\":\"2021-09-21T13:00:00-04:00\",\"deliveredDate\":\"2021-09-22T18:00:00-04:00\",\"transportType\":\"VR\",\"transportTypeGroup\":\"VAN\",\"transportMode\":\"FTL\",\"status\":\"OPEN\",\"details\":{\"distance\":434,\"miles\":434,\"commodity\":\"Racks\",\"weight\":22000,\"tenderedDate\":\"2020-01-11T16:00:00Z\",\"bookedDate\":\"2020-01-11T16:00:00Z\",\"tordFlag\":false,\"hazmat\":false,\"hotshot\":false,\"teamDrive\":false,\"overdimensional\":false,\"dedicatedCarrierContract\":false,\"asset\":false,\"pricingType\":\"Spot\",\"pricingTypeGroup\":\"SPOT\",\"carrierAccountManager\":\"John Doe\",\"shipperAccountManager\":\"John Doe\",\"salesManager\":\"John Doe\",\"userGroupId\":\"Main office\",\"office\":\"Main office\"},\"shipper\":{\"id\":\"12345\",\"name\":\"Shipper company\"},\"carrier\":{\"id\":\"12345\",\"name\":\"Carrier company\"}}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/batch/import-load:
    post:
      tags:
        - TMS
      summary: Imports loads in batches
      security:
        - TmsConnector_bearerAuth: []
      description: Used to import and/or update loads in batches
      operationId: tmsBatchImportLoad
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_BatchImportLoadRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_BatchImportLoadResponse"
        "400":
          $ref: "#/paths/~1tms~1import-load/post/responses/400"
        "401":
          $ref: "#/paths/~1tms~1import-load/post/responses/401"
        "403":
          $ref: "#/paths/~1tms~1import-load/post/responses/403"
        "422":
          $ref: "#/paths/~1tms~1import-load/post/responses/422"
        "429":
          $ref: "#/paths/~1tms~1import-load/post/responses/429"
        "500":
          $ref: "#/paths/~1tms~1import-load/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/batch/import-load',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                loads: [
                  {
                    loadId: '12345',
                    origin: {
                      country: 'US',
                      city: 'Sacramento',
                      state: 'CA',
                      zip: '95814',
                      appointmentDateTime: '2020-10-13T09:00:00Z',
                      scheduledAppointmentStartedAt: '2020-10-13T09:00:00Z',
                      scheduledAppointmentEndedAt: '2020-10-13T11:00:00Z',
                      arrivedAt: '2020-10-13T09:15:00Z',
                      departedAt: '2020-10-13T10:45:00Z'
                    },
                    destination: {
                      country: 'US',
                      city: 'Sacramento',
                      state: 'CA',
                      zip: '95814',
                      appointmentDateTime: '2020-10-13T09:00:00Z',
                      scheduledAppointmentStartedAt: '2020-10-13T09:00:00Z',
                      scheduledAppointmentEndedAt: '2020-10-13T11:00:00Z',
                      arrivedAt: '2020-10-13T09:15:00Z',
                      departedAt: '2020-10-13T10:45:00Z'
                    },
                    extraStops: [
                      {
                        order: 0,
                        address: {country: 'US', city: 'Red Bluff', state: 'CA', zip: '96080'},
                        type: 'LOAD',
                        appointmentDateTime: '2020-10-14T16:00:00Z'
                      },
                      {
                        order: 1,
                        address: {country: 'US', city: 'Redding', state: 'CA', zip: '96002'},
                        type: 'UNLOAD',
                        appointmentDateTime: '2020-10-15T16:00:00Z'
                      }
                    ],
                    rate: {
                      totalShipperLinehaulCost: 1176,
                      totalLinehaulCost: 956,
                      totalFuelCost: 45,
                      accessorials: [{name: 'Overweight', shipperCost: 200, carrierCost: 0}],
                      totalShipperCost: 1276,
                      totalCarrierCost: 1130,
                      currency: 'USD'
                    },
                    pickupDate: '2021-09-21T13:00:00-04:00',
                    deliveredDate: '2021-09-22T18:00:00-04:00',
                    transportType: 'VR',
                    transportTypeGroup: 'VAN',
                    transportMode: 'FTL',
                    status: 'OPEN',
                    details: {
                      distance: 434,
                      miles: 434,
                      commodity: 'Racks',
                      weight: 22000,
                      tenderedDate: '2020-01-11T16:00:00Z',
                      bookedDate: '2020-01-11T16:00:00Z',
                      tordFlag: false,
                      hazmat: false,
                      hotshot: false,
                      teamDrive: false,
                      overdimensional: false,
                      dedicatedCarrierContract: false,
                      asset: false,
                      pricingType: 'Spot',
                      pricingTypeGroup: 'SPOT',
                      carrierAccountManager: 'John Doe',
                      shipperAccountManager: 'John Doe',
                      salesManager: 'John Doe',
                      userGroupId: 'Main office',
                      office: 'Main office'
                    },
                    shipper: {id: '12345', name: 'Shipper company'},
                    carrier: {id: '12345', name: 'Carrier company'}
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/batch/import-load"


            payload = {"loads": [
                    {
                        "loadId": "12345",
                        "origin": {
                            "country": "US",
                            "city": "Sacramento",
                            "state": "CA",
                            "zip": "95814",
                            "appointmentDateTime": "2020-10-13T09:00:00Z",
                            "scheduledAppointmentStartedAt": "2020-10-13T09:00:00Z",
                            "scheduledAppointmentEndedAt": "2020-10-13T11:00:00Z",
                            "arrivedAt": "2020-10-13T09:15:00Z",
                            "departedAt": "2020-10-13T10:45:00Z"
                        },
                        "destination": {
                            "country": "US",
                            "city": "Sacramento",
                            "state": "CA",
                            "zip": "95814",
                            "appointmentDateTime": "2020-10-13T09:00:00Z",
                            "scheduledAppointmentStartedAt": "2020-10-13T09:00:00Z",
                            "scheduledAppointmentEndedAt": "2020-10-13T11:00:00Z",
                            "arrivedAt": "2020-10-13T09:15:00Z",
                            "departedAt": "2020-10-13T10:45:00Z"
                        },
                        "extraStops": [
                            {
                                "order": 0,
                                "address": {
                                    "country": "US",
                                    "city": "Red Bluff",
                                    "state": "CA",
                                    "zip": "96080"
                                },
                                "type": "LOAD",
                                "appointmentDateTime": "2020-10-14T16:00:00Z"
                            },
                            {
                                "order": 1,
                                "address": {
                                    "country": "US",
                                    "city": "Redding",
                                    "state": "CA",
                                    "zip": "96002"
                                },
                                "type": "UNLOAD",
                                "appointmentDateTime": "2020-10-15T16:00:00Z"
                            }
                        ],
                        "rate": {
                            "totalShipperLinehaulCost": 1176,
                            "totalLinehaulCost": 956,
                            "totalFuelCost": 45,
                            "accessorials": [
                                {
                                    "name": "Overweight",
                                    "shipperCost": 200,
                                    "carrierCost": 0
                                }
                            ],
                            "totalShipperCost": 1276,
                            "totalCarrierCost": 1130,
                            "currency": "USD"
                        },
                        "pickupDate": "2021-09-21T13:00:00-04:00",
                        "deliveredDate": "2021-09-22T18:00:00-04:00",
                        "transportType": "VR",
                        "transportTypeGroup": "VAN",
                        "transportMode": "FTL",
                        "status": "OPEN",
                        "details": {
                            "distance": 434,
                            "miles": 434,
                            "commodity": "Racks",
                            "weight": 22000,
                            "tenderedDate": "2020-01-11T16:00:00Z",
                            "bookedDate": "2020-01-11T16:00:00Z",
                            "tordFlag": False,
                            "hazmat": False,
                            "hotshot": False,
                            "teamDrive": False,
                            "overdimensional": False,
                            "dedicatedCarrierContract": False,
                            "asset": False,
                            "pricingType": "Spot",
                            "pricingTypeGroup": "SPOT",
                            "carrierAccountManager": "John Doe",
                            "shipperAccountManager": "John Doe",
                            "salesManager": "John Doe",
                            "userGroupId": "Main office",
                            "office": "Main office"
                        },
                        "shipper": {
                            "id": "12345",
                            "name": "Shipper company"
                        },
                        "carrier": {
                            "id": "12345",
                            "name": "Carrier company"
                        }
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/batch/import-load",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"loads\":[{\"loadId\":\"12345\",\"origin\":{\"country\":\"US\",\"city\":\"Sacramento\",\"state\":\"CA\",\"zip\":\"95814\",\"appointmentDateTime\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentStartedAt\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentEndedAt\":\"2020-10-13T11:00:00Z\",\"arrivedAt\":\"2020-10-13T09:15:00Z\",\"departedAt\":\"2020-10-13T10:45:00Z\"},\"destination\":{\"country\":\"US\",\"city\":\"Sacramento\",\"state\":\"CA\",\"zip\":\"95814\",\"appointmentDateTime\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentStartedAt\":\"2020-10-13T09:00:00Z\",\"scheduledAppointmentEndedAt\":\"2020-10-13T11:00:00Z\",\"arrivedAt\":\"2020-10-13T09:15:00Z\",\"departedAt\":\"2020-10-13T10:45:00Z\"},\"extraStops\":[{\"order\":0,\"address\":{\"country\":\"US\",\"city\":\"Red Bluff\",\"state\":\"CA\",\"zip\":\"96080\"},\"type\":\"LOAD\",\"appointmentDateTime\":\"2020-10-14T16:00:00Z\"},{\"order\":1,\"address\":{\"country\":\"US\",\"city\":\"Redding\",\"state\":\"CA\",\"zip\":\"96002\"},\"type\":\"UNLOAD\",\"appointmentDateTime\":\"2020-10-15T16:00:00Z\"}],\"rate\":{\"totalShipperLinehaulCost\":1176,\"totalLinehaulCost\":956,\"totalFuelCost\":45,\"accessorials\":[{\"name\":\"Overweight\",\"shipperCost\":200,\"carrierCost\":0}],\"totalShipperCost\":1276,\"totalCarrierCost\":1130,\"currency\":\"USD\"},\"pickupDate\":\"2021-09-21T13:00:00-04:00\",\"deliveredDate\":\"2021-09-22T18:00:00-04:00\",\"transportType\":\"VR\",\"transportTypeGroup\":\"VAN\",\"transportMode\":\"FTL\",\"status\":\"OPEN\",\"details\":{\"distance\":434,\"miles\":434,\"commodity\":\"Racks\",\"weight\":22000,\"tenderedDate\":\"2020-01-11T16:00:00Z\",\"bookedDate\":\"2020-01-11T16:00:00Z\",\"tordFlag\":false,\"hazmat\":false,\"hotshot\":false,\"teamDrive\":false,\"overdimensional\":false,\"dedicatedCarrierContract\":false,\"asset\":false,\"pricingType\":\"Spot\",\"pricingTypeGroup\":\"SPOT\",\"carrierAccountManager\":\"John Doe\",\"shipperAccountManager\":\"John Doe\",\"salesManager\":\"John Doe\",\"userGroupId\":\"Main office\",\"office\":\"Main office\"},\"shipper\":{\"id\":\"12345\",\"name\":\"Shipper company\"},\"carrier\":{\"id\":\"12345\",\"name\":\"Carrier company\"}}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/import-carrier:
    post:
      tags:
        - TMS
      summary: Import carrier
      security:
        - TmsConnector_bearerAuth: []
      description: Import a new carrier or update an existing one
      operationId: tmsImportCarrier
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_CarrierProfile"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_ImportProfileResponse"
        "400":
          $ref: "#/paths/~1tms~1import-load/post/responses/400"
        "401":
          $ref: "#/paths/~1tms~1import-load/post/responses/401"
        "403":
          $ref: "#/paths/~1tms~1import-load/post/responses/403"
        "422":
          description: Unprocessable Entity.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_Error"
              examples:
                error422Example:
                  value:
                    code: missing_property
                    message: "Missing property: body"
        "429":
          $ref: "#/paths/~1tms~1import-load/post/responses/429"
        "500":
          $ref: "#/paths/~1tms~1import-load/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/import-carrier',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                profileId: '13441524',
                companyName: 'Carggo',
                legalName: 'Carggo',
                mc: '122356',
                dot: '87650005',
                scac: 'CGGK',
                contact: {name: 'John', phoneNumber: '121331343', email: 'my@email.com'},
                status: 'ACTIVE'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/import-carrier"


            payload = {
                "profileId": "13441524",
                "companyName": "Carggo",
                "legalName": "Carggo",
                "mc": "122356",
                "dot": "87650005",
                "scac": "CGGK",
                "contact": {
                    "name": "John",
                    "phoneNumber": "121331343",
                    "email": "my@email.com"
                },
                "status": "ACTIVE"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/import-carrier",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"profileId\":\"13441524\",\"companyName\":\"Carggo\",\"legalName\":\"Carggo\",\"mc\":\"122356\",\"dot\":\"87650005\",\"scac\":\"CGGK\",\"contact\":{\"name\":\"John\",\"phoneNumber\":\"121331343\",\"email\":\"my@email.com\"},\"status\":\"ACTIVE\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/batch/import-carrier:
    post:
      tags:
        - TMS
      summary: Import carriers in batches
      security:
        - TmsConnector_bearerAuth: []
      description: Import a batch of carrier profiles
      operationId: tmsBatchImportCarrier
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_BatchImportCarrierRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_BatchImportProfileResponse"
        "400":
          $ref: "#/paths/~1tms~1import-load/post/responses/400"
        "401":
          $ref: "#/paths/~1tms~1import-load/post/responses/401"
        "403":
          $ref: "#/paths/~1tms~1import-load/post/responses/403"
        "422":
          $ref: "#/paths/~1tms~1import-carrier/post/responses/422"
        "429":
          $ref: "#/paths/~1tms~1import-load/post/responses/429"
        "500":
          $ref: "#/paths/~1tms~1import-load/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/batch/import-carrier',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                carriers: [
                  {
                    profileId: '13441524',
                    companyName: 'Carggo',
                    legalName: 'Carggo',
                    mc: '122356',
                    dot: '87650005',
                    scac: 'CGGK',
                    contact: {name: 'John', phoneNumber: '121331343', email: 'my@email.com'},
                    status: 'ACTIVE'
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/batch/import-carrier"


            payload = {"carriers": [
                    {
                        "profileId": "13441524",
                        "companyName": "Carggo",
                        "legalName": "Carggo",
                        "mc": "122356",
                        "dot": "87650005",
                        "scac": "CGGK",
                        "contact": {
                            "name": "John",
                            "phoneNumber": "121331343",
                            "email": "my@email.com"
                        },
                        "status": "ACTIVE"
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/batch/import-carrier",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"carriers\":[{\"profileId\":\"13441524\",\"companyName\":\"Carggo\",\"legalName\":\"Carggo\",\"mc\":\"122356\",\"dot\":\"87650005\",\"scac\":\"CGGK\",\"contact\":{\"name\":\"John\",\"phoneNumber\":\"121331343\",\"email\":\"my@email.com\"},\"status\":\"ACTIVE\"}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/import-shipper:
    post:
      tags:
        - TMS
      summary: Import shipper
      security:
        - TmsConnector_bearerAuth: []
      description: Import a new shipper or update an existing one
      operationId: tmsShipper
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_ShipperProfile"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_ImportProfileResponse"
        "400":
          $ref: "#/paths/~1tms~1import-load/post/responses/400"
        "401":
          $ref: "#/paths/~1tms~1import-load/post/responses/401"
        "403":
          $ref: "#/paths/~1tms~1import-load/post/responses/403"
        "422":
          $ref: "#/paths/~1tms~1import-carrier/post/responses/422"
        "429":
          $ref: "#/paths/~1tms~1import-load/post/responses/429"
        "500":
          $ref: "#/paths/~1tms~1import-load/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/import-shipper',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                profileId: '13441524',
                companyName: 'Carggo',
                legalName: 'Carggo',
                contact: {name: 'John', phoneNumber: '121331343', email: 'my@email.com'},
                accountManager: 'JAMES',
                status: 'ACTIVE',
                userGroupId: 'Main office'
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/import-shipper"


            payload = {
                "profileId": "13441524",
                "companyName": "Carggo",
                "legalName": "Carggo",
                "contact": {
                    "name": "John",
                    "phoneNumber": "121331343",
                    "email": "my@email.com"
                },
                "accountManager": "JAMES",
                "status": "ACTIVE",
                "userGroupId": "Main office"
            }

            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/import-shipper",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"profileId\":\"13441524\",\"companyName\":\"Carggo\",\"legalName\":\"Carggo\",\"contact\":{\"name\":\"John\",\"phoneNumber\":\"121331343\",\"email\":\"my@email.com\"},\"accountManager\":\"JAMES\",\"status\":\"ACTIVE\",\"userGroupId\":\"Main office\"}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
  /tms/batch/import-shipper:
    post:
      tags:
        - TMS
      summary: Import shippers in batches
      security:
        - TmsConnector_bearerAuth: []
      description: Import a batch of shipper profiles
      operationId: tmsBatchImportShipper
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TmsConnector_BatchImportShipperRequest"
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TmsConnector_BatchImportProfileResponse"
        "400":
          $ref: "#/paths/~1tms~1import-load/post/responses/400"
        "401":
          $ref: "#/paths/~1tms~1import-load/post/responses/401"
        "403":
          $ref: "#/paths/~1tms~1import-load/post/responses/403"
        "422":
          $ref: "#/paths/~1tms~1import-carrier/post/responses/422"
        "429":
          $ref: "#/paths/~1tms~1import-load/post/responses/429"
        "500":
          $ref: "#/paths/~1tms~1import-load/post/responses/500"
      x-codeSamples:
        - lang: Node + Request
          source: >
            const request = require('request');


            const options = {
              method: 'POST',
              url: 'https://testapi.greenscreens.ai/v2/tms/batch/import-shipper',
              headers: {
                'content-type': 'application/json',
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              },
              body: {
                shippers: [
                  {
                    profileId: '13441524',
                    companyName: 'Carggo',
                    legalName: 'Carggo',
                    contact: {name: 'John', phoneNumber: '121331343', email: 'my@email.com'},
                    accountManager: 'JAMES',
                    status: 'ACTIVE',
                    userGroupId: 'Main office'
                  }
                ]
              },
              json: true
            };


            request(options, function (error, response, body) {
              if (error) throw new Error(error);

              console.log(body);
            });
        - lang: Python + Requests
          source: >-
            import requests


            url = "https://testapi.greenscreens.ai/v2/tms/batch/import-shipper"


            payload = {"shippers": [
                    {
                        "profileId": "13441524",
                        "companyName": "Carggo",
                        "legalName": "Carggo",
                        "contact": {
                            "name": "John",
                            "phoneNumber": "121331343",
                            "email": "my@email.com"
                        },
                        "accountManager": "JAMES",
                        "status": "ACTIVE",
                        "userGroupId": "Main office"
                    }
                ]}
            headers = {
                "content-type": "application/json",
                "Authorization": "Bearer REPLACE_BEARER_TOKEN"
            }


            response = requests.request("POST", url, json=payload, headers=headers)


            print(response.text)
        - lang: Php + Curl
          source: >-
            <?php


            $curl = curl_init();


            curl_setopt_array($curl, [
              CURLOPT_URL => "https://testapi.greenscreens.ai/v2/tms/batch/import-shipper",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "POST",
              CURLOPT_POSTFIELDS => "{\"shippers\":[{\"profileId\":\"13441524\",\"companyName\":\"Carggo\",\"legalName\":\"Carggo\",\"contact\":{\"name\":\"John\",\"phoneNumber\":\"121331343\",\"email\":\"my@email.com\"},\"accountManager\":\"JAMES\",\"status\":\"ACTIVE\",\"userGroupId\":\"Main office\"}]}",
              CURLOPT_HTTPHEADER => [
                "Authorization: Bearer REPLACE_BEARER_TOKEN",
                "content-type: application/json"
              ],
            ]);


            $response = curl_exec($curl);

            $err = curl_error($curl);


            curl_close($curl);


            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
    servers:
      - url: https://testapi.greenscreens.ai/v2
        description: Testing server (dev environment)
      - url: https://sandboxapi.greenscreens.ai/v2
        description: Sandbox server (as stable as production, but has no data)
      - url: https://api.greenscreens.ai/v2
        description: Production server (uses live data)
components:
  schemas:
    Analytics_AnalyticsLaneTopCarriersResponse:
      type: object
      description: Analytics lane carriers response
      properties:
        items:
          type: array
          description: List of carriers
          maxItems: 10
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneCarrierItem"
      required:
        - items
    Analytics_AnalyticsLaneCarrierItem:
      type: object
      properties:
        carrierName:
          type: string
          description: Carrier Name
          example: Eagle One Delivery
        carrierPhone:
          type: string
          description: Carrier phone
          example: "121331343"
        carrierEmail:
          type: string
          description: Carrier email
          example: test@carrier.com
        carrierMC:
          type: string
          description: Motor Carrier number of this carrier
          example: MC00334234
        carrierDOT:
          type: string
          description: Department of Transportation number of this carrier
          example: USDOT33136
        carrierSCAC:
          type: string
          description: Standard Carrier Alpha Code of this carrier
          example: MAEU
        numberOfLoads:
          type: integer
          description: Number of loads that this carrier handled
          example: 41
        lastShippedDate:
          type: string
          description: Date of the last time this carrier handled a load. In ISO date
            format (YYYY-MM-DD).
          format: date
          example: "2019-09-30"
        carriedMultistopLoadsBefore:
          type: boolean
          description: Signifies whether this carrier has ever carried a multistop load
            before
          example: false
        lastCarrierRate:
          type: number
          description: Rate that was paid to this carrier for the last handled load (per
            mile)
          example: 2.1254
        averageCarrierRate:
          type: number
          description: Average rate paid to this carrier (per mile)
          example: 2.1254
        minCarrierRate:
          type: number
          description: Minimum rate paid to this carrier (per mile)
          example: 2.1254
        maxCarrierRate:
          type: number
          description: Maximum rate paid to this carrier (per mile)
          example: 2.1254
        lastCarrierFlatRate:
          type: number
          description: Flat rate that was paid to this carrier for the last handled load
          example: 1340
        averageCarrierFlatRate:
          type: number
          description: Average flat rate paid to this carrier
          example: 1250
        minCarrierFlatRate:
          type: number
          description: Minimum flat rate paid to this carrier
          example: 1200
        maxCarrierFlatRate:
          type: number
          description: Maximum flat rate paid to this carrier
          example: 1350
        averageCarrierMarginPercent:
          type: number
          description: Average margin percent for this carrier
          example: 15
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
        performanceMetrics:
          $ref: "#/components/schemas/Analytics_PerformanceMetricsObject"
      required:
        - carrierName
        - numberOfLoads
        - lastShippedDate
        - carriedMultistopLoadsBefore
        - lastCarrierRate
        - averageCarrierRate
        - minCarrierRate
        - maxCarrierRate
        - lastCarrierFlatRate
        - averageCarrierFlatRate
        - minCarrierFlatRate
        - maxCarrierFlatRate
        - averageCarrierMarginPercent
        - currency
    Analytics_AnalyticsLaneResponse:
      type: object
      title: AnalyticsLaneResponse
      properties:
        coverTime:
          type: integer
          description: Time (average) to cover the lane in hours
          example: 247
        laneMarginPercent:
          type: number
          description: Margin per lane (last month, average)
          example: 15.21
        laneUrgency:
          type: integer
          description: Time (average) between pickup and book in hours
          example: 287
        travelTime:
          type: integer
          description: Travel time in hours
          example: 49
        mileage:
          type: number
          description: Mileage in miles
          example: 978
    Analytics_AnalyticsLaneHighwayCarriersResponse:
      type: object
      description: Highway carriers response
      properties:
        highwayCarrierListUrl:
          type: string
          description: Url to a lane search screen in the Highway app
          example: https://gohighway.com/broker/carriers/lane-search
        carriers:
          type: array
          description: List of carriers returned by the Highway platform
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneHighwayCarriersResponseItem"
      required:
        - highwayCarrierListUrl
        - carriers
    Analytics_AnalyticsLaneHighwayCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Highway platform. 

        Only available if the current company is a client of the Highway platform.
      properties:
        name:
          type: string
          description: Name of the carrier company
          example: COIN LLC
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        mc:
          type: string
          description: Motor Carrier number (MC) of this carrier
          example: "554398"
        email:
          type: string
          description: Carrier dispatch email
          example: carrier@mail.com
        phone:
          type: string
          description: Carrier dispatch phone number
          example: "4112228888"
        laneCertainty:
          $ref: "#/components/schemas/Analytics_HighwayLaneCertainty"
        fleet:
          type: number
          description: >
            Number of trailers in this carriers fleet that match the transport
            type

            in the request
          example: 48
        assessment:
          type: string
          enum:
            - PASS
            - PARTIAL_PASS
          description: Carrier assesment result
          example: PARTIAL_PASS
        highwayCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the Highway app
          example: https://gohighway.com/broker/carriers/28661
    Analytics_HighwayLaneCertainty:
      type: object
      description: |
        Lane certainty info for this carrier for requested lane
      properties:
        observed:
          $ref: "#/components/schemas/Analytics_HighwayCertaintyLevel"
        preferred:
          $ref: "#/components/schemas/Analytics_HighwayCertaintyLevel"
        headquarters:
          $ref: "#/components/schemas/Analytics_HighwayCertaintyLevel"
    Analytics_HighwayCertaintyLevel:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
      description: Certainty level
      example: LOW
    Analytics_AnalyticsLaneCargoChiefCarriersResponse:
      type: object
      description: Cargo Chief carriers response
      properties:
        cargoChiefCarrierListUrl:
          type: string
          description: Url to a carrier search screen in the Cargo Chief app
          example: https://cargochief.app/search/capacity?...
        carriers:
          type: array
          description: List of Cargo Chief carriers matched for this lane
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneCargoChiefCarriersResponseIt\
              em"
      required:
        - carriers
    Analytics_AnalyticsLaneCargoChiefCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Cargo Chief platform. 

        Only available if the current company is a client of the Cargo Chief platform.
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        inNetwork:
          type: boolean
          description: |
            Signifies whether this carrier is in the user's Cargo Chief network
          example: true
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: USDOT33136
        mc:
          type: string
          description: Motor Carrier (MC) number of this carrier
          example: MC00334234
        contacts:
          $ref: "#/components/schemas/Analytics_CargoChiefCarrierContacts"
        rating:
          type: integer
          description: Cargo Chief platform carrier rating for this lane + carrier match
          example: 75
        cargoChiefCarrierViewUrl:
          type: string
          description: Url to a carrier view screen in the Cargo Chief app
          example: https://cargochief.app/carrier/T2ZmaWNlOjIxMTE0NjIw
    Analytics_CargoChiefCarrierContacts:
      type: object
      description: Cargo Chief carrier contacts info
      properties:
        name:
          type: string
          description: Contact name
          example: James
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    Analytics_AnalyticsLaneYatCarriersResponse:
      type: object
      description: Yat.ai carriers response
      properties:
        yatCarrierListUrl:
          type: string
          description: Url to a carrier search screen in the Yat.ai app
          example: https://portal.yat.ai/search/capacity?...
        carriers:
          type: array
          description: List of Yat.ai carriers
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneYatCarriersResponseItem"
      required:
        - carriers
    Analytics_AnalyticsLaneYatCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Yat.ai platform. 

        Only available if the current company is a client of the Yat.ai platform.
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        mc:
          type: string
          description: Motor Carrier number (MC) of this carrier
          example: "554398"
        fleet:
          type: integer
          description: Number of trucks in this carriers fleet
          example: 48
        contacts:
          $ref: "#/components/schemas/Analytics_YatCarrierContacts"
        score:
          $ref: "#/components/schemas/Analytics_YatCarrierScore"
        yatCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the Yat.ai app
          example: https://portal.yat.ai/carriers/28661
    Analytics_YatCarrierContacts:
      type: object
      description: Yat.ai carrier contacts info
      properties:
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    Analytics_YatCarrierScore:
      type: object
      description: Yat.ai carrier match score info
      properties:
        normalizedScore:
          type: number
          description: >
            Normalized score, this is the result of combining other scores in
            this object
          example: 99.8374
        sizeScore:
          type: number
          description: |
            Size score
          example: 88.9431
        originScore:
          type: number
          description: |
            Origin score
          example: 97.7236
        destinationScore:
          type: number
          description: |
            Destination score
          example: 79.6748
        relationshipScore:
          type: number
          description: |
            Relationship score
          example: 0
        laneScore:
          type: number
          description: |
            Lane score
          example: 75.2846
    Analytics_AnalyticsLaneCarrierSourceCarriersResponse:
      type: object
      description: CarrierSource carriers response
      properties:
        carrierSourceCarrierListUrl:
          type: string
          description: Url to a lane search screen in the CarrierSource app
          example: https://carriersource.is/lane-search
        carriers:
          type: array
          description: List of carriers returned by the CarrierSource platform
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneCarrierSourceCarriersRespons\
              eItem"
      required:
        - carrierSourceCarrierListUrl
        - carriers
    Analytics_AnalyticsLaneCarrierSourceCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the CarrierSource platform. 

        Only available if the current company is a client of the CarrierSource platform
      properties:
        name:
          type: string
          description: Name of the carrier company
          example: COIN LLC
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        contacts:
          $ref: "#/components/schemas/Analytics_CarrierSourceCarrierContacts"
        rating:
          $ref: "#/components/schemas/Analytics_CarrierSourceCarrierRating"
        carrierSourceCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the CarrierSource app
          example: https://www.carriersource.io/carriers/p-h-services-inc
    Analytics_CarrierSourceCarrierContacts:
      type: object
      description: CarrierSource carrier contacts info
      properties:
        email:
          type: string
          description: Carrier dispatch email
          example: carrier@mail.com
        phone:
          type: string
          description: Carrier dispatch phone number
          example: "121331343"
    Analytics_CarrierSourceCarrierRating:
      type: object
      description: CarrierSource carrier rating info
      properties:
        starRating:
          type: number
          format: float
          minimum: 0
          maximum: 5
          description: The star rating of this carrier
          example: 4.3
        reviewCount:
          type: integer
          description: The count of reviews used to calculate the star rating
          example: 343
    Analytics_AnalyticsLaneChaineCarriersResponse:
      type: object
      description: Chaine carriers response
      properties:
        chaineCarrierListUrl:
          type: string
          description: Url to a lane search screen in the Chaine app
          example: https://app.chaine.com/broker/carriers/lane-search
        carriers:
          type: array
          description: List of Chaine carriers matched for this lane
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneChaineCarriersResponseItem"
      required:
        - carriers
    Analytics_AnalyticsLaneChaineCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Chaine platform. 

        Only available if the current company is a client of the Chaine platform.
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: USDOT33136
        mc:
          type: string
          description: Motor Carrier (MC) number of this carrier
          example: MC00334234
        contacts:
          $ref: "#/components/schemas/Analytics_ChaineCarrierContacts"
        numberOfTrips:
          type: integer
          description: |
            The number of trips the carrier has completed
          example: 34
        averageRate:
          type: number
          description: |
            The average rate the matched carrier ran the lane for
          example: 2.1254
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
        chaineCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the Chaine app
          example: https://app.chaine.com/broker/carriers/28661
      required:
        - currency
    Analytics_ChaineCarrierContacts:
      type: object
      description: Chaine carrier contacts info
      properties:
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    Analytics_AnalyticsLaneTruckstopCarriersResponse:
      type: object
      description: Truckstop carriers response
      properties:
        truckstopCarrierListUrl:
          type: string
          description: Url to a truck search screen in the Truckstop app
          example: https://app.truckstop.com/Search/Trucks/
        carriers:
          type: array
          description: List of Truckstop carriers matched for this lane
          maxItems: 20
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneTruckstopCarriersResponseIte\
              m"
      required:
        - truckstopCarrierListUrl
        - carriers
    Analytics_AnalyticsLaneTruckstopCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Truckstop platform. 

        Only available if the current company is a client of the Truckstop platform
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        mc:
          type: string
          description: Motor Carrier number (MC) of this carrier
          example: "554398"
        truckAvailableDate:
          type: string
          format: date
          description: Date when the truck becomes available
          example: "2024-05-15"
        truckPostedDateTime:
          type: string
          format: date-time
          description: Date when the truck was posted on the loadboard
          example: "2024-01-11T16:00:00Z"
        origin:
          $ref: "#/components/schemas/Analytics_TruckstopCarrierLocation"
        destination:
          $ref: "#/components/schemas/Analytics_TruckstopCarrierLocation"
        contacts:
          $ref: "#/components/schemas/Analytics_TruckstopCarrierContacts"
        truckstopCarrierViewUrl:
          type: string
          description: Url to a truck posting screen in the Truckstop app
          example: https://app.truckstop.com/PostingDetails/Trucks/76427839
    Analytics_TruckstopCarrierContacts:
      type: object
      description: Truckstop carrier contacts info
      properties:
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    Analytics_TruckstopCarrierLocation:
      type: object
      description: Truckstop truck location info
      properties:
        country:
          type: string
          description: |
            Code of the country where the truck is currently located.

            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: |
            Code of the State where the truck is currently located
          example: TX
        city:
          type: string
          description: |
            Name of the city where the truck is currently located
          example: Dallas
        distance:
          type: number
          description: |
            How far the truck is from the searched area (in miles)
          example: 34
    Analytics_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    Analytics_GeographicalAreaLane:
      type: string
      enum:
        - CITY
        - CITY_ZIP
        - ZIP_CITY
        - ZIP
      description: >
        Determines the size of the area around origin and destination points, 

        that will be searched for the related data.

        * CITY - narrow, city wide, area

        * ZIP - narrow, five digit zip, area

        * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

        * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
      example: ZIP
    Analytics_AnalyticsLanePerformanceMetricsResponse:
      type: object
      description: Lane Performance Metrics. These include both broker-specific and
        market benchmark metrics
      properties:
        brokerPerformanceMetrics:
          $ref: "#/components/schemas/Analytics_PerformanceMetricsObject"
        networkPerformanceMetrics:
          $ref: "#/components/schemas/Analytics_PerformanceMetricsObject"
        networkPerformanceRanks:
          $ref: "#/components/schemas/Analytics_PerformanceRanksObject"
      required:
        - brokerPerformanceMetrics
        - networkPerformanceMetrics
    Analytics_PerformanceMetricsObject:
      type: object
      description: Performance metrics
      properties:
        onTimePickup:
          type: number
          description: On Time Pickup %
          minimum: 0
          maximum: 100
          example: 85.24
        onTimeDelivery:
          type: number
          description: On Time Delivery %
          minimum: 0
          maximum: 100
          example: 63.13
        badBounce:
          type: number
          description: Bad Bounce %
          minimum: 0
          maximum: 100
          example: 75.42
        score:
          type: number
          description: T-Score
          example: 98.24
          minimum: 0
          maximum: 100
        leadTimeAverageHours:
          type: number
          description: Booking Lead Time (Avg, in Hrs:Min)
          example: 5
        volume:
          type: number
          description: Volume
          example: 1234
        lastDeliveredDate:
          type: string
          description: Last Delivered At Date
          example: "2026-04-28"
    Analytics_PerformanceRanksObject:
      type: object
      description: Performance ranks
      properties:
        onTimePickup:
          type: string
          description: On Time Pickup Rank
          example: Top 25%
        onTimeDelivery:
          type: string
          description: On Time Delivery Rank
          example: Bottom 50%
        badBounce:
          type: string
          description: Bad Bounce Rank
          example: Bottom 25%
        leadTimeAverageHours:
          type: string
          description: Booking Lead Time Rank
          example: Top 50%
        volume:
          type: string
          description: Volume Rank
          example: Top 10%
    Analytics_AnalyticsLaneStrategicCapacityResponse:
      type: object
      description: Analytics lane Strategic Capacity response
      properties:
        items:
          type: array
          description: List of carriers
          maxItems: 10
          items:
            $ref: "#/components/schemas/Analytics_AnalyticsLaneStrategicCapacityCarrierItem"
      required:
        - items
    Analytics_AnalyticsLaneStrategicCapacityCarrierItem:
      type: object
      properties:
        carrierName:
          type: string
          description: Carrier Name
          example: Eagle One Delivery
        carrierPhone:
          type: string
          description: Carrier phone
          example: "121331343"
        carrierEmail:
          type: string
          description: Carrier email
          example: test@carrier.com
        carrierMC:
          type: string
          description: Motor Carrier number of this carrier
          example: MC00334234
        carrierDOT:
          type: string
          description: Department of Transportation number of this carrier
          example: USDOT33136
        isInNetwork:
          type: boolean
          description: Signifies whether this carrier is in the network
          example: true
        performanceMetrics:
          $ref: "#/components/schemas/Analytics_PerformanceMetricsObject"
        transportTypes:
          type: array
          description: List of transport types this carrier is known to support
          items:
            $ref: "#/components/schemas/Analytics_TransportType"
      required:
        - carrierName
        - performanceMetrics
    Analytics_MarketCode:
      type: string
      description: Machine readable code of a market area
      example: NY_ALB
    Bids_BidActionRequest:
      type: object
      description: Carries data necessary for accepting a bid
      properties:
        key:
          type: string
          description: Key of the bid which you want to accept
          example: c5d1cfa8-228b-11eb-adc1-0242ac120002
        bidCost:
          type: number
          description: Bid rate from user
          example: 1000.5
        carrierName:
          type: string
          description: Carrier company name
          example: Carrierr Transportation
        carrierMC:
          type: string
          description: Carrier MC number
          example: "888015"
        carrierComment:
          type: string
          description: Comment for broker
          example: Looks good
        currency:
          $ref: "#/components/schemas/Bids_Currency"
      required:
        - key
        - bidCost
        - carrierName
    Bids_BidsSendRequest:
      type: object
      properties:
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the bid
          example: buddy@greenscreens.ai
        carriers:
          type: array
          description: |
            List of carriers to whom the bid request should be sent to
          items:
            $ref: "#/components/schemas/Bids_BidsSendRequestCarrier"
        carrierEmailList:
          type: array
          items:
            type: string
            nullable: true
          deprecated: true
          minItems: 0
          maxItems: 500
          description: |
            List of emails that the bid request should be sent to

            __Deprecated: use `carriers` field instead__
          example:
            - carrier1@mail.com
            - carrier2@mail.com
            - carrier3@mail.com
        carrierPhoneList:
          type: array
          items:
            type: string
            nullable: true
          deprecated: true
          minItems: 0
          maxItems: 500
          description: >
            List of phone numbers that the bid request should be sent to as a
            message.


            __This feature only works if you have 'TextLocate' integration enabled for your company.__


            _Valid phone number is a string with ten digits in it._


            __Deprecated: use `carriers` field instead__
          example:
            - "8456951387"
            - "7456951583"
            - "2458951391"
        origin:
          $ref: "#/components/schemas/Bids_Address"
        destination:
          $ref: "#/components/schemas/Bids_Address"
        extraStops:
          $ref: "#/components/schemas/Bids_StopsInput"
        pickupDateTime:
          type: string
          format: date-time
          description: >
            Pick up date with time in time zone of the pick up location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00.
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: >
            Delivered date with time in time zone of drop off location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        loadProNumber:
          type: string
          description: Internal load pro number
          example: Pro#111111
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 20000
        commodity:
          type: string
          description: commodity description in free form
          example: Steel racks
        brokerComment:
          type: string
          description: Comment for carrier
          example: Please, be carefully with my load
        transportType:
          $ref: "#/components/schemas/Bids_TransportType"
      required:
        - carrierName
        - origin
        - destination
        - transportType
    Bids_BidsSendRequestCarrier:
      type: object
      description: |
        Describes a carrier 
        and how a bid request to that carrier should be made
      properties:
        carrierInfo:
          $ref: "#/components/schemas/Bids_BidsSendRequestCarrierCarrierInfo"
        carrierInfoSource:
          type: string
          description: The source of the carrier info
          enum:
            - MANUAL_ENTRY
            - CLIENT_DATA_CARRIER_SEARCH
            - CLIENT_DATA_BIDS
            - CLIENT_DATA_TOP_CARRIERS
            - STRATEGIC_CAPACITY
            - HIGHWAY
            - CARGO_CHIEF
            - YAT
            - TRUCKSTOP
            - CARRIER_SOURCE
            - CHAINE
            - OTHER
          example: HIGHWAY
        sendRequestTo:
          type: array
          uniqueItems: true
          minItems: 1
          description: >
            List of channels that bid requests should be sent through.


            * CARRIER_INFO_PHONE - a bid request will be sent to

            the phone number provided in the `carrierInfo.phone` field. 

            __This only works if you have SMS bids functionality enabled for your company__

            * CARRIER_INFO_EMAIL - a bid request will be sent to

            the email address provided in the `carrierInfo.email` field


            If several values are provided then several bid requests will be

            created and sent through appropriate channels
          items:
            type: string
            description: The channel that the bid request can be sent through
            enum:
              - CARRIER_INFO_EMAIL
              - CARRIER_INFO_PHONE
            example: CARRIER_INFO_EMAIL
      required:
        - sendRequestTo
    Bids_BidsSendRequestCarrierCarrierInfo:
      type: object
      description: Describes the carrier to whom the bid request is sent
      properties:
        name:
          type: string
          description: Carrier company name
          example: CarrierCompany
        mc:
          type: string
          description: Carrier MC number
          example: "888015"
        dot:
          type: string
          description: Carrier DOT number
          example: "87650005"
        phone:
          type: string
          description: Carrier contact phone number
          example: "4112228888"
        email:
          type: string
          description: Carrier contact email address
          example: carrier@mail.com
    Bids_BidObject:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: id of the bid
          example: 23456
        userEmail:
          type: string
          description: Email of the owner of the bid
          example: buddy@greenscreens.ai
        pickupDateTime:
          type: string
          format: date-time
          description: Related load pickup date
          example: "2020-09-14T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Related load delivery date
          example: "2020-09-14T16:00:00Z"
        createdDate:
          type: string
          format: date-time
          description: Bid creation date
          example: "2020-09-14T16:00:00Z"
        bidStatus:
          $ref: "#/components/schemas/Bids_BidStatus"
        bidCost:
          type: number
          description: Bid rate
          example: 1000.5
        wasViewed:
          type: boolean
          description: States whether the bid was viewed by the broker after being
            accepted by carrier
          example: false
        carrierName:
          type: string
          description: Carrier company name
          example: Carrierr Transportation
        carrierMC:
          type: string
          description: Carrier MC number
          example: "888015"
        carrierPhone:
          type: string
          description: Carrier contact phone number
          example: "4112228888"
        carrierEmail:
          type: string
          description: Carrier contact email
          example: test@greenscreens.ai
        transportType:
          $ref: "#/components/schemas/Bids_TransportType"
        origin:
          $ref: "#/components/schemas/Bids_Address"
        destination:
          $ref: "#/components/schemas/Bids_Address"
        extraStops:
          $ref: "#/components/schemas/Bids_Stops"
        loadProNumber:
          type: string
          description: Internal load pro number
        weight:
          description: Total cargo weight in lb
          type: number
          format: float
          example: 20000
        commodity:
          type: string
          description: Commodity description in free form
          example: Very important load
        brokerComment:
          type: string
          description: Comment for carrier
          example: Please, be carefully with my load
        carrierComment:
          type: string
          description: Comment for broker
          example: Looks good
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
      required:
        - userEmail
        - bidStatus
        - pickupDate
        - deliveredDate
        - bidCost
        - carrierName
        - carrierEmail
        - transportType
        - origin
        - destination
        - extraStops
        - wasViewed
        - currency
    Bids_BidResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Bid ID in the platform
          example: 12345
        key:
          type: string
          description: Unique key used to create a link to the bid in the platform
          example: deedc41f-7eb2-4c36-9d35-fb6958a43771
      required:
        - id
        - key
    Bids_BidsResponse:
      type: object
      description: Object containing an array of bids
      properties:
        items:
          type: array
          description: Array of bids
          items:
            $ref: "#/components/schemas/Bids_BidObject"
      required:
        - items
    Bids_BidsRequest:
      type: object
      properties:
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the bid
          example: buddy@greenscreens.ai
        carrierName:
          type: string
          description: Carrier company name
          example: CarrierCompany
        carrierMC:
          type: string
          description: Carrier MC number
          example: "888015"
        carrierDOT:
          type: string
          description: Carrier DOT number
          example: "87650005"
        carrierEmail:
          type: string
          nullable: true
          description: User email
          example: carrier@mail.com
        carrierPhone:
          type: string
          nullable: true
          description: Carrier contact phone number
          example: "4112228888"
        origin:
          $ref: "#/components/schemas/Bids_Address"
        destination:
          $ref: "#/components/schemas/Bids_Address"
        extraStops:
          $ref: "#/components/schemas/Bids_StopsInput"
        transportType:
          $ref: "#/components/schemas/Bids_TransportType"
        pickupDateTime:
          type: string
          format: date-time
          nullable: true
          description: >
            Pick up date with time in time zone of the pick up location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          nullable: true
          description: >
            Delivered date with time in time zone of drop off location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        bidDateTime:
          type: string
          format: date-time
          nullable: true
          description: The date and time when the bid was created
          example: "2020-10-11T16:00:00Z"
        bidCost:
          type: number
          description: Bid rate
          example: 1000.5
        loadProNumber:
          type: string
          nullable: true
          description: Internal load pro number
          example: Pro#111111
        weight:
          type: number
          format: float
          nullable: true
          description: Total cargo weight in lb
          example: 20000
        commodity:
          type: string
          nullable: true
          description: Commodity description in free form
          example: Steel racks
        brokerComment:
          type: string
          nullable: true
          description: Comment for carrier
          example: Something a broker would comment
        carrierComment:
          type: string
          nullable: true
          description: Comment from carrier
          example: Looks good
        currency:
          $ref: "#/components/schemas/Bids_Currency"
      required:
        - carrierName
        - origin
        - destination
        - transportType
        - bidCost
    Bids_BidsUpdateRequest:
      type: object
      properties:
        carrierName:
          type: string
          description: Carrier company name
          example: CarrierCompany
        carrierMC:
          type: string
          description: Carrier MC number
          example: "888015"
        carrierEmail:
          type: string
          nullable: true
          description: User email
          example: carrier@mail.com
        carrierPhone:
          type: string
          nullable: true
          description: Carrier contact phone number
          example: "4112228888"
        origin:
          $ref: "#/components/schemas/Bids_Address"
        destination:
          $ref: "#/components/schemas/Bids_Address"
        extraStops:
          $ref: "#/components/schemas/Bids_StopsInput"
        transportType:
          $ref: "#/components/schemas/Bids_TransportType"
        pickupDateTime:
          type: string
          format: date-time
          nullable: true
          description: >
            Pick up date with time in time zone of the pick up location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          nullable: true
          description: >
            Delivered date with time in time zone of drop off location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        bidDateTime:
          type: string
          format: date-time
          nullable: true
          description: The date and time when the bid was created
          example: "2020-10-11T16:00:00Z"
        bidCost:
          type: number
          description: Bid rate
          example: 1000.5
        loadProNumber:
          type: string
          nullable: true
          description: Internal load pro number
          example: Pro#111111
        weight:
          type: number
          format: float
          nullable: true
          description: Total cargo weight in lb
          example: 20000
        commodity:
          type: string
          nullable: true
          description: Commodity description in free form
          example: Steel racks
        brokerComment:
          type: string
          nullable: true
          description: Comment for carrier
          example: Something a broker would comment
        carrierComment:
          type: string
          nullable: true
          description: Comment from carrier
          example: Looks good
        wasViewed:
          type: boolean
          description: States whether the bid was viewed by the broker after being
            accepted by carrier
          example: false
        currency:
          $ref: "#/components/schemas/Bids_Currency"
      required:
        - carrierName
        - origin
        - destination
        - transportType
        - bidCost
    Bids_BidStatus:
      type: string
      enum:
        - SENT
        - RECEIVED
        - FAILED
        - AWARDED
      description: Bid status
      example: SENT
    Bids_BidStatusImport:
      type: string
      enum:
        - SENT
        - RECEIVED
        - AWARDED
      description: Bid status
      example: SENT
    Bids_CarrierInfoResponse:
      type: object
      description: Contains a list of carriers
      properties:
        items:
          type: array
          description: List of carriers
          items:
            $ref: "#/components/schemas/Bids_CarrierInfoObject"
      required:
        - items
    Bids_CarrierInfoObject:
      type: object
      properties:
        companyName:
          type: string
          description: Carrier company name
          example: Carrier Company
        email:
          type: string
          description: Carrier contact email
          example: test@greenscreens.ai
        phoneNumber:
          type: string
          description: Carrier contact phone number
          example: "4112228888"
      required:
        - companyName
    Bids_Stops:
      type: array
      description: Stops list
      items:
        $ref: "#/components/schemas/Bids_Stop"
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
            type: ZIP
          type: LOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
            type: CITY
          type: UNLOAD
          appointmentDateTime: "2020-10-15T16:00:00Z"
    Bids_StopsInput:
      type: array
      description: Stops list
      items:
        $ref: "#/components/schemas/Bids_StopInput"
      example:
        - order: 0
          address:
            country: US
            zip: "96080"
          type: LOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
          type: UNLOAD
          appointmentDateTime: "2020-10-15T16:00:00Z"
    Bids_Stop:
      type: object
      description: Contains the stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/Bids_StopAddress"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    Bids_StopInput:
      type: object
      description: Contains the stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/Bids_StopAddressInput"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop.

            Leave this field empty if you do not know the stop type.
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    Bids_StopAddress:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
        zip:
          type: string
          description: Zip
          example: "12345"
        type:
          type: string
          enum:
            - CITY
            - ZIP
          example: ZIP
          description: Type of address
      required:
        - country
        - state
        - city
        - zip
        - type
    Bids_StopAddressInput:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
        zip:
          type: string
          description: Zip
          example: "12345"
      required:
        - country
    Bids_Carrier:
      type: object
      description: Imported bid carrier information
      properties:
        id:
          type: string
          description: Customer TMS ID of the carrier profile associated with this bid
          example: "64378901"
        name:
          type: string
          description: Carrier company name
          example: CarrierCompany
        mc:
          type: string
          description: Carrier MC number
          example: "888015"
        dot:
          type: string
          description: Carrier DOT number
          example: "87650005"
        email:
          type: string
          description: Carrier contact email
          example: carrier@mail.com
        phone:
          type: string
          description: Carrier contact phone number
          example: "4112228888"
      required:
        - name
    Bids_RecentBidsResponse:
      type: object
      description: Contains an array of bids
      properties:
        items:
          type: array
          description: bids
          items:
            $ref: "#/components/schemas/Bids_BidObject"
    Bids_BidByKeyResponse:
      type: object
      allOf:
        - $ref: "#/components/schemas/Bids_BidObject"
      properties:
        distance:
          type: number
          description: Total distance of the trip (in miles)
          example: 289
      required:
        - distance
    Bids_BidsResponseMessage:
      allOf:
        - $ref: "#/components/schemas/Bids_ResponseMessage"
        - type: object
          properties:
            serviceResponse:
              type: string
              x-enum-varnames:
                - no_bid_recipients
                - bid_expired
              enum:
                - No bid recipients, email or phone, provided
                - Bid has expired due to past pickup date
    Bids_BidsImportRequest:
      type: object
      description: A body of the request to import a bid
      properties:
        bidId:
          type: string
          description: |
            Unique bid id from the customers system. 

            If a bid with the same bidId will be found in our platform, 
            it will be updated. Otherwise a new bid will be created
          example: Q#54321
        loadId:
          type: string
          description: Associated load id (pro number)
          example: Pro#111111
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the bid
          example: buddy@greenscreens.ai
        transportType:
          type: string
          description: Transport type (original transport type used in provider TMS)
          example: VR
        transportTypeGroup:
          $ref: "#/components/schemas/Bids_TransportTypeGroup"
        stops:
          $ref: "#/components/schemas/Bids_StopsInput"
        pickupDateTime:
          type: string
          format: date-time
          description: >
            Pick up date with time in time zone of the pick up location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00.
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: >
            Delivered date with time in time zone of drop off location.


            The time zone you provide will be ignored, 

            so you have to make sure that the day and the hours are exactly 

            those that you want to store in our system. 


            e.g. if the load has to be delivered at 16:00 in the time zone

            of the drop off point, you have to send us 16:00 in this string.


            e.g. if you send 2020-10-13T16:00:00Z in utc, our system will

            cut off the UTC time zone, and attach the time zone of the pick up point,

            but the date and time will still stay 2020-10-13T16:00:00
          example: "2020-10-13T16:00:00Z"
        bidDateTime:
          type: string
          format: date-time
          description: The date and time when the bid was created
          example: "2020-10-11T16:00:00Z"
        status:
          $ref: "#/components/schemas/Bids_BidStatusImport"
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 20000
        commodity:
          type: string
          description: Commodity description in free form
          example: Steel racks
        brokerComment:
          type: string
          description: Comment from broker to carrier
          example: Something a broker would comment
        carrierComment:
          type: string
          description: Comment from carrier
          example: Looks good
        carrier:
          $ref: "#/components/schemas/Bids_Carrier"
        bidCost:
          type: number
          description: Bid cost (flat)
          example: 1000.5
        currency:
          $ref: "#/components/schemas/Bids_Currency"
      required:
        - bidId
        - userEmail
        - transportType
        - transportTypeGroup
        - stops
        - pickupDateTime
        - status
        - bidCost
        - carrier
        - currency
    Bids_BidsBatchImportResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of bid import responses
          items:
            $ref: "#/components/schemas/Bids_BidsBatchImportResponseItem"
      required:
        - responses
    Bids_BidsBatchImportResponseItem:
      type: object
      description: |
        Response for this particular bid import attempt
      properties:
        bidId:
          type: string
          description: Unique bid id from the customers system
          example: Q#54321
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
            - ERROR
          description: |
            Bid import status. 
            * CREATED - a new bid was created
            * UPDATED - an existing bid was updated
            * ERROR - an error occurred during bid import
          example: CREATED
        error:
          type: object
          description: >
            Import attempt error data. Available when the import attempt was
            unsuccessful and the status is ERROR
          properties:
            code:
              type: string
              description: Unique string identifier of the error
              example: validation_errors_occurred
            message:
              type: string
              description: Human readable error message
              example: Validation errors occurred, check errors array for details
            errors:
              type: array
              description: A list of validation errors that occurred during the import
                attempt.
              items:
                $ref: "#/components/schemas/Bids_RequestValidationError"
          required:
            - code
            - message
            - errors
      required:
        - bidId
        - status
    Bids_BidsOtherCompanyBatchImportRequest:
      type: object
      properties:
        companyId:
          type: string
          description: |
            Id of the company that you want the bids to be imported for
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
        bids:
          type: array
          description: List of bids to import
          items:
            $ref: "#/components/schemas/Bids_BidsImportRequest"
          maxItems: 1000
      required:
        - companyId
        - bids
    Bids_Address:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
        type:
          type: string
          enum:
            - CITY
            - ZIP
          example: ZIP
          description: Type of address
      required:
        - city
        - state
        - zip
        - type
    Bids_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    Bids_TransportTypeGroup:
      type: string
      description: Transport type group
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
        - OTHER
      example: VAN
    Bids_Currency:
      type: string
      enum:
        - USD
        - CAD
      description: |
        Currency code in ISO 4217 format (three letter code, e.g. USD)

        _If not provided, defaults to the currency set in the profile 
        of currently authenticated user (or currently authenticated company 
        if there is no user or user profile setting)_
      example: USD
    Bids_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    Bids_ResponseMessage:
      type: object
      properties:
        commonResponse:
          type: string
          x-enum-varnames:
            - not_readable_message
            - access_forbidden
            - item_not_found
            - request_timeout
            - request_validation
            - parse_error
            - internal_error
            - access_forbidden_companyId
            - method_not_allowed
            - missing_required_parameter
          enum:
            - "Body request is not readable : %s"
            - Access is forbidden
            - Item not found
            - Request timeout after {} sec
            - You have one or more errors in request structure
            - "Text '%s' could not be parsed in field: %s"
            - Internal server error
            - companyId in JWT token is not equals importCompanyId in request
              body
            - Method not allowed
            - Missing required parameter
        serviceResponse:
          type: string
    Bids_RequestValidationError:
      type: object
      description: Request validation error
      properties:
        field:
          type: string
          description: Name of the field that did not pass validation
          example: transportType
        message:
          type: string
          description: Human readable error mesage explaining why validation failed
          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
            FLATBED, ...]
        value:
          type: string
          nullable: true
          description: Value of the field that did not pass validation
          example: SpaceXDragon
      required:
        - field
        - message
    DataLake_DatalakeCustomerResponse:
      type: object
      description: Response containing matching customer names
      properties:
        items:
          type: array
          description: list of 10 matching customers
          items:
            $ref: "#/components/schemas/DataLake_DatalakeCustomerObject"
      required:
        - items
    DataLake_DatalakeCustomerObject:
      type: object
      properties:
        customerName:
          type: string
          description: customer name
          example: Joes Foods
      required:
        - customerName
    DataLake_DataLakeResponseMessage:
      allOf:
        - type: object
          properties:
            commonResponse:
              type: string
              x-enum-varnames:
                - not_readable_message
                - access_forbidden
                - item_not_found
                - request_timeout
                - request_validation
                - parse_error
                - internal_error
                - access_forbidden_companyId
                - method_not_allowed
                - missing_required_parameter
              enum:
                - "Body request is not readable : %s"
                - Access is forbidden
                - Item not found
                - Request timeout after {} sec
                - You have one or more errors in request structure
                - "Text '%s' could not be parsed in field: %s"
                - Internal server error
                - companyId in JWT token is not equals importCompanyId in
                  request body
                - Method not allowed
                - Missing required parameter
            serviceResponse:
              type: string
        - type: object
          properties:
            serviceResponse:
              type: string
              x-enum-varnames:
                - distance_calculation_error
                - amount_of_stops
                - illlegal_profile_status
                - illegal_format_value
              enum:
                - Unable to calculate distance between zips %s %s, reason %s
                - The amount of stops is less than two
                - Can not save profile with status D
                - "Illegal value : %s for field %s"
    DataLake_Stops:
      type: array
      description: Stop list
      items:
        $ref: "#/components/schemas/DataLake_Stop"
      example:
        - order: 0
          type: LOAD
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
          appointmentDateTime: "2020-10-13T16:00:00Z"
        - order: 1
          type: UNLOAD
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
          appointmentDateTime: "2020-10-14T16:00:00Z"
    DataLake_StopsInput:
      type: array
      description: Extra stops between origin and destination
      items:
        $ref: "#/components/schemas/DataLake_StopInput"
      example:
        - order: 0
          type: LOAD
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
        - order: 1
          type: UNLOAD
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
    DataLake_Stop:
      type: object
      description: Contains the stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/DataLake_Address"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    DataLake_StopInput:
      type: object
      description: Contains the stop information e.g. address
      nullable: true
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/DataLake_AddressInput"
      required:
        - order
        - address
    DataLake_Address:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - state
        - city
    DataLake_AddressInput:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - country
        - zip
    DataLake_Location:
      type: object
      description: location specified by address or geopoint
      properties:
        country:
          type: string
          format: US for United States
          example: US
        city:
          type: string
          example: Chicago
        state:
          type: string
          example: IL
        zip:
          type: string
          example: "60636"
        streetAddress:
          type: string
          example: 600 E Grand Ave
        latitude:
          type: number
          format: double
          example: 41.891844
        longitude:
          type: number
          format: double
          example: -87.602912
      example:
        country: US
        city: Chicago
        state: IL
        zip: "60611"
        streetAddress: 600 E Grand Ave
        latitude: 41.891844
        longitude: -87.602912
      required:
        - city
        - state
    DataLake_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    DataLake_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    DataLake_Region:
      type: string
      enum:
        - CITY
        - CITY_ZIP
        - ZIP_CITY
        - ZIP
        - 3DZIP
        - KMA
      description: >
        Determines the size of the area around the origin and destination
        points, 

        that will be searched for the related data.

        * CITY - narrow, city wide, area

        * ZIP - narrow, five digit zip, area

        * 3DZIP - medium, short zip, area

        * KMA - big, market wide, area

        * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

        * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
      example: ZIP
    History_HistoryAggregatedResponse:
      type: object
      description: list of rates
      properties:
        items:
          $ref: "#/components/schemas/History_RateAggregatedArray"
      required:
        - items
    History_RateAggregatedArray:
      type: array
      description: List of aggregated rates
      items:
        $ref: "#/components/schemas/History_RateAggregatedObject"
    History_RateAggregatedObject:
      type: object
      properties:
        medianFlatRate:
          type: number
          description: average carrier cost inc fuel
          example: 1765.13
        medianRate:
          type: number
          description: average carrier rate inc fuel
          example: 1765.13
        date:
          type: integer
          format: int64
          description: DateTime in format UNIX
          example: 1599130005
        minAndMaxFlatRate:
          type: array
          items:
            type: number
          minItems: 2
          maxItems: 2
          description: minimum and maximum carrier cost inc fuel
          example:
            - 1250.5
            - 2500.92
        minAndMaxRate:
          type: array
          items:
            type: number
          minItems: 2
          maxItems: 2
          description: minimum and maximum carrier rate inc fuel
          example:
            - 1.58
            - 4.2
        loadCount:
          type: integer
          description: the amount of load for the route
          example: 15
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
      required:
        - medianFlatRate
        - medianRate
        - date
        - minAndMaxFlatRate
        - minAndMaxRate
        - loadCount
        - currency
    History_SimilarHistoryAggregatedResponse:
      type: object
      description: >
        Similar lane aggregated rate history response

        containing the rate history and a list of top similar lanes wih rate data
      properties:
        history:
          $ref: "#/components/schemas/History_RateAggregatedArray"
        topLanes:
          $ref: "#/components/schemas/History_SimilarHistoryAggregatedTopLanes"
      required:
        - history
        - topLanes
    History_SimilarHistoryAggregatedTopLanes:
      type: array
      description: Top lanes similar to requested lane
      items:
        $ref: "#/components/schemas/History_SimilarHistoryAggregatedTopLane"
    History_SimilarHistoryAggregatedTopLane:
      type: object
      description: Similar lane data
      properties:
        rates:
          $ref: "#/components/schemas/History_SimilarHistoryAggregatedTopLaneRates"
        originCountry:
          type: string
          description: |
            Origin country. 
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        originState:
          type: string
          description: Origin state
          example: IL
        originCity:
          type: string
          description: Origin city
          example: Chicago
        destinationCountry:
          type: string
          description: |
            Destination country. 
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        destinationState:
          type: string
          description: Destination state
          example: TX
        destinationCity:
          type: string
          description: Destination city
          example: Houston
        distance:
          type: number
          format: float
          description: Total distance of the trip (in miles)
          example: 434
        loadCount:
          type: integer
          description: Load volume for this route
          example: 15
      required:
        - rates
        - originCountry
        - originState
        - originCity
        - destinationCountry
        - destinationState
        - destinationCity
        - distance
        - loadCount
    History_SimilarHistoryAggregatedTopLaneRates:
      type: object
      description: Rates
      properties:
        min:
          type: number
          description: Minimum rate (per mile, including fuel)
          example: 1765.13
        max:
          type: number
          description: Maximum rate (per mile, including fuel)
          example: 2344.27
        median:
          type: number
          description: Median rate (per mile, including fuel)
          example: 2034.64
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217
          example: USD
      required:
        - min
        - max
        - median
        - currency
    History_SimilarLanesExplainResponse:
      type: object
      description: |
        Similar lanes breakdown for "Explain This Rate" feature.
        Returns all matching lanes (up to 500) in a single response.
        Frontend handles pagination client-side.
      properties:
        items:
          type: array
          description: Similar lanes sorted by volume descending (up to 500)
          items:
            $ref: "#/components/schemas/History_SimilarLaneRow"
        totalLoads:
          type: integer
          description: Sum of volumes across all items
          example: 1345
      required:
        - items
        - totalLoads
    History_SimilarLaneRow:
      type: object
      description: Similar lane with rate statistics grouped by city pair.
      properties:
        shipIntervalStart:
          type: string
          format: date
          description: Earliest ship date on this lane
          example: "2025-01-18"
        shipIntervalEnd:
          type: string
          format: date
          description: Latest ship date on this lane
          example: "2025-02-18"
        originCity:
          type: string
          description: Origin city
          example: Lebanon
        originState:
          type: string
          description: Origin state code
          example: TN
        originCountry:
          type: string
          description: Origin country code (ISO 3166-1 alpha-2)
          example: US
        proximityOrigin:
          type: number
          format: float
          description: Miles from requested origin to this lane's origin
          example: 12.5
        destinationCity:
          type: string
          description: Destination city
          example: Orlando
        destinationState:
          type: string
          description: Destination state code
          example: FL
        destinationCountry:
          type: string
          description: Destination country code (ISO 3166-1 alpha-2)
          example: US
        proximityDest:
          type: number
          format: float
          description: Miles from requested destination to this lane's destination
          example: 8.3
        mileage:
          type: integer
          description: Average lane distance in miles
          example: 692
        rates:
          $ref: "#/components/schemas/History_SimilarLaneRates"
        volume:
          type: integer
          description: Number of loads on this lane
          example: 5541
      required:
        - shipIntervalStart
        - shipIntervalEnd
        - originCity
        - originState
        - originCountry
        - proximityOrigin
        - destinationCity
        - destinationState
        - destinationCountry
        - proximityDest
        - mileage
        - rates
        - volume
    History_SimilarLaneRates:
      type: object
      description: Rate statistics for a similar lane (flat rates and RPM)
      properties:
        avgFlat:
          type: number
          format: float
          description: Average carrier flat rate
          example: 2582.46
        minFlat:
          type: number
          format: float
          description: Minimum carrier flat rate
          example: 1550
        maxFlat:
          type: number
          format: float
          description: Maximum carrier flat rate
          example: 3000
        avgRpm:
          type: number
          format: float
          description: Average carrier rate per mile
          example: 3.73
        minRpm:
          type: number
          format: float
          description: Minimum carrier rate per mile
          example: 2.24
        maxRpm:
          type: number
          format: float
          description: Maximum carrier rate per mile
          example: 4.33
        currency:
          type: string
          description: Code of the currency of the response
          example: USD
      required:
        - avgFlat
        - minFlat
        - maxFlat
        - avgRpm
        - minRpm
        - maxRpm
        - currency
    History_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    History_GeographicalArea:
      type: string
      enum:
        - CITY
        - CITY_ZIP
        - ZIP_CITY
        - ZIP
        - 3DZIP
        - KMA
      description: >
        Determines the size of the area around the origin and destination
        points, 

        that will be searched for the related data.

        * CITY - narrow, city wide, area

        * ZIP - narrow, five digit zip, area

        * 3DZIP - medium, short zip, area

        * KMA - big, market wide, area

        * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

        * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
      example: ZIP
    History_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    History_ReportingResponseMessage:
      allOf:
        - type: object
          properties:
            commonResponse:
              type: string
              x-enum-varnames:
                - not_readable_message
                - access_forbidden
                - item_not_found
                - request_timeout
                - request_validation
                - parse_error
                - internal_error
                - access_forbidden_companyId
                - method_not_allowed
                - missing_required_parameter
              enum:
                - "Body request is not readable : %s"
                - Access is forbidden
                - Item not found
                - Request timeout after {} sec
                - You have one or more errors in request structure
                - "Text '%s' could not be parsed in field: %s"
                - Internal server error
                - companyId in JWT token is not equals importCompanyId in
                  request body
                - Method not allowed
                - Missing required parameter
            serviceResponse:
              type: string
        - type: object
          properties:
            serviceResponse:
              type: string
              x-enum-varnames:
                - access_forbidden
                - internal_error
                - not_readable_message
                - parse_error
                - request_validation
              enum:
                - Access forbidden
                - Internal server error
                - "Not readable message: %s"
                - "Parse error: value '%s' could not be parsed in field '%s'"
                - "Request validation error: %s"
    History_StopsInputRecentRates:
      type: array
      description: Extra stops between origin and destination
      items:
        $ref: "#/components/schemas/History_StopInputRecentRates"
      example:
        - order: 0
          type: LOAD
          address:
            country: US
            state: CA
            city: Red Bluff
            zip: "96080"
        - order: 1
          type: UNLOAD
          address:
            country: US
            state: CA
            city: Redding
            zip: "96002"
    History_StopInputRecentRates:
      type: object
      description: Contains the stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/History_AddressInputRecentRates"
      required:
        - order
        - address
    History_AddressInputRecentRates:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - country
        - state
        - city
        - zip
    History_RatesStatsRequest:
      type: object
      properties:
        originCountry:
          type: string
          description: |
            Origin country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        originState:
          type: string
          description: Origin state
          example: NY
        originCity:
          type: string
          description: Origin city
          example: Schenectady
        originZip:
          type: string
          description: Origin zip
          example: "12345"
        destinationCountry:
          type: string
          description: |
            Destination country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        destinationState:
          type: string
          description: Destination state
          example: IL
        destinationCity:
          type: string
          description: Destination city
          example: Chicago
        destinationZip:
          type: string
          description: Destination zip
          example: "60636"
        extraStops:
          $ref: "#/components/schemas/History_StopsInputRecentRates"
        transportType:
          $ref: "#/components/schemas/History_TransportType"
        region:
          $ref: "#/components/schemas/History_GeographicalArea"
        currency:
          type: string
          description: Code of the currency that you want the response to be in. Format is
            ISO 4217.
          example: USD
      required:
        - originZip
        - originCity
        - originState
        - destinationZip
        - destinationCity
        - destinationState
        - transportType
        - region
    History_RatesStatsResponse:
      type: object
      description: rates for periods 15, 30, 60, 90 days
      properties:
        historyRates:
          type: array
          items:
            $ref: "#/components/schemas/History_RatesStatsForPeriod"
    History_RatesStatsForPeriod:
      type: object
      properties:
        loadCount:
          type: integer
          example: 42
        medianFlatRate:
          type: number
          format: double
          example: 123.45
        medianRate:
          type: number
          format: double
          example: 67.89
        durationInDays:
          type: integer
          example: 7
        region:
          $ref: "#/components/schemas/History_GeographicalArea"
        rateSource:
          type: string
          description: Source of the rate data
          example: NETWORK
    History_LoadsHistoryRequest:
      type: object
      properties:
        originCountry:
          type: string
          description: |
            Origin country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        originState:
          type: string
          description: Origin state
          example: NY
        originCity:
          type: string
          description: Origin city
          example: Schenectady
        originZip:
          type: string
          description: Origin zip
          example: "12345"
        destinationCountry:
          type: string
          description: |
            Destination country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        destinationState:
          type: string
          description: Destination state
          example: IL
        destinationCity:
          type: string
          description: Destination city
          example: Chicago
        destinationZip:
          type: string
          description: Destination zip
          example: "12345"
        extraStops:
          $ref: "#/components/schemas/History_StopsInput"
        dateFrom:
          type: string
          format: date
          description: Pickup date range start date
          example: "2020-07-21"
        dateTo:
          type: string
          format: date
          description: Pickup date range end date
          example: "2020-07-21"
        transportType:
          $ref: "#/components/schemas/History_TransportType"
        region:
          $ref: "#/components/schemas/History_GeographicalArea"
        currency:
          type: string
          description: >
            Code of the currency that you want the response to be in.

            Format is ISO 4217.


            If not provided, defaults to the currency set in the profile of currently authenticated user.
          example: USD
      required:
        - originZip
        - destinationZip
        - transportType
        - dateFrom
        - dateTo
        - region
    History_LoadsHistoryResponse:
      type: object
      description: list of rates
      properties:
        items:
          type: array
          description: |
            List of rate objects that are deemed valid and
            used during ML training
          items:
            $ref: "#/components/schemas/History_LoadRateObject"
        outlierItems:
          type: array
          description: |
            List of outlier rate objects that are deemed invalid and
            ignored during ML training
          items:
            $ref: "#/components/schemas/History_LoadRateObject"
      required:
        - items
        - outlierItems
    History_LoadRateObject:
      type: object
      description: Load data
      properties:
        totalCarrierCost:
          type: number
          description: Total carrier rate (flat, including fuel)
          example: 1765.13
        totalCarrierRate:
          type: number
          description: Total carrier rate (per mile, including fuel)
          example: 2.58
        loadPickupDate:
          type: string
          format: date
          description: |
            Pickup date of the load.

            **Deprecated.** Use `pickupDateTime` instead
          example: "2020-07-21"
          deprecated: true
        pickupDateTime:
          type: string
          format: date-time
          description: Pickup date and time of the load
          example: "2020-07-21T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Delivery date and time of the load
          example: "2020-10-14T16:00:00Z"
        transportTypeTms:
          type: string
          description: Transport type (original transport type used in provider TMS)
          example: VR
        distance:
          type: number
          description: Distance that the load covered (in miles)
          example: 689
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        commodity:
          type: string
          description: Commodity description in free form
          example: Racks
        originCountry:
          type: string
          description: |
            Origin country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        originState:
          type: string
          description: Origin state
          example: IL
        originCity:
          type: string
          description: Origin city
          example: Chicago
        originZip:
          type: string
          description: Origin zip
          example: "60636"
        destinationCountry:
          type: string
          description: |
            Destination country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        destinationState:
          type: string
          description: Destination state
          example: TX
        destinationCity:
          type: string
          description: Destination city
          example: Houston
        destinationZip:
          type: string
          description: Destination zip
          example: "73264"
        extraStops:
          $ref: "#/components/schemas/History_ExtraStops"
        carrierName:
          type: string
          description: Carrier company name
          example: JB Hunt
        carrierPhoneNumber:
          type: string
          description: Carrier contact number
          example: "121331343"
        carrierEmail:
          type: string
          description: Carrier contact email
          example: my@carrieremail.com
        customerName:
          type: string
          description: Shipper company name
          example: BP
        customerPhoneNumber:
          type: string
          description: Customer contact number
          example: "121331343"
        customerEmail:
          type: string
          description: Customer contact email
          example: my@customeremail.com
        sellRate:
          type: number
          description: Total shipper rate (flat, including fuel)
          example: 1900.5
        buySideRep:
          type: string
          description: Carrier contact manager
          example: Jon Johnson
        sellSideRep:
          type: string
          description: Shipper contact manager
          example: Deny Williams
        loadProNumber:
          type: string
          description: Load PRO number in broker TMS
          example: 0-5428
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
      required:
        - loadPickupDate
        - originState
        - originCity
        - destinationState
        - destinationCity
        - currency
        - extraStops
    History_ExtraStops:
      type: array
      items:
        $ref: "#/components/schemas/History_ExtraStop"
      description: >
        Any extra stops along the route between the origin and destination points
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
          type: LOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
          type: UNLOAD
          appointmentDateTime: "2020-10-15T16:00:00Z"
    History_ExtraStop:
      type: object
      description: Extra stop
      properties:
        order:
          type: integer
          description: Extra stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/History_ExtraStopAddress"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop.
            Leave this field empty if you do not know the stop type.
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop.
            Provide the time zone of the stop location if possible.
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    History_ExtraStopAddress:
      type: object
      description: |
        Location specified by country, city, state and zip code.
        * Country is required
        * Either city-state pair or zip code is required
        * All four parameters can be passed together
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        city:
          type: string
          description: City name
          example: Sacramento
        state:
          type: string
          description: Two letter state code
          example: CA
        zip:
          type: string
          description: Zip code
          example: "95814"
      required:
        - country
    History_RecentRatesRequest:
      type: object
      properties:
        originCountry:
          type: string
          description: |
            Origin country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        originState:
          type: string
          description: Origin state
          example: NY
        originCity:
          type: string
          description: Origin city
          example: Schenectady
        originZip:
          type: string
          description: Origin zip
          example: "12345"
        destinationCountry:
          type: string
          description: |
            Destination country.
            Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        destinationState:
          type: string
          description: Destination state
          example: IL
        destinationCity:
          type: string
          description: Destination city
          example: Chicago
        destinationZip:
          type: string
          description: Destination zip
          example: "60636"
        extraStops:
          $ref: "#/components/schemas/History_StopsInputRecentRates"
        transportType:
          $ref: "#/components/schemas/History_TransportType"
        region:
          $ref: "#/components/schemas/History_GeographicalArea"
        currency:
          type: string
          description: Code of the currency that you want the response to be in. Format is
            ISO 4217.
          example: USD
      required:
        - originZip
        - originCity
        - originState
        - destinationZip
        - destinationCity
        - destinationState
        - transportType
        - region
    History_RecentRatesResponse:
      type: object
      description: rates for three periods
      properties:
        last7Day:
          $ref: "#/components/schemas/History_RecentRateObject"
        last15Day:
          $ref: "#/components/schemas/History_RecentRateObject"
        last30Day:
          $ref: "#/components/schemas/History_RecentRateObject"
    History_RecentRateObject:
      type: object
      properties:
        maxLineHaulFlatRate:
          type: number
          description: Max flat rate for period
          example: 1208.54
        maxLineHaulRate:
          type: number
          description: Max per-mile rate for period
          example: 2.568
        minLineHaulFlatRate:
          type: number
          description: Min flat rate for period
          example: 1001.92
        minLineHaulRate:
          type: number
          description: Min per-mile rate for period
          example: 1.981
        averageLineHaulFlatRate:
          type: number
          description: Flat rate for period
          example: 1200.12
        averageLineHaulRate:
          type: number
          description: Per-mile rate for period
          example: 2.1254
        numberOfReports:
          type: integer
          description: number of reports in period
          example: 7
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
      required:
        - maxLineHaulFlatRate
        - maxLineHaulRate
        - minLineHaulFlatRate
        - minLineHaulRate
        - averageLineHaulFlatRate
        - averageLineHaulRate
        - numberOfReports
        - currency
    History_StopsInput:
      type: array
      description: Extra stops between origin and destination
      items:
        $ref: "#/components/schemas/History_StopInput"
      example:
        - order: 0
          type: LOAD
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
        - order: 1
          type: UNLOAD
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
    History_StopInput:
      type: object
      description: Contains the stop information e.g. address
      nullable: true
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/History_AddressInput"
      required:
        - order
        - address
    History_AddressInput:
      type: object
      description: Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - country
        - zip
    MarketIntelligence_GsIndexRequest:
      type: object
      properties:
        zip:
          type: string
          description: Area identifyed by zip
          example: "60636"
        date:
          type: string
          format: date
          description: Date in ISO format YYYY-MM-DD
          example: "2019-09-18"
        location:
          type: string
          enum:
            - ORIGIN
            - DESTINATION
          description: Location type for influence calculation
          example: ORIGIN
      required:
        - zip
        - date
        - location
    MarketIntelligence_GsIndexResponse:
      type: object
      properties:
        inboundLoadFlow:
          $ref: "#/components/schemas/MarketIntelligence_GsIndexValue"
        outboundLoadFlow:
          $ref: "#/components/schemas/MarketIntelligence_GsIndexValue"
    MarketIntelligence_GsIndexValue:
      type: object
      description: Market index data
      properties:
        instant:
          type: number
          description: Index instant value
          example: 56
        derivative:
          type: number
          description: Index derivative value in percent
          example: 19
        trend:
          type: string
          enum:
            - FLAT
            - UP
            - DOWN
          description: Index trend
          example: UP
        trendOutcome:
          type: string
          enum:
            - NEGATIVE
            - POSITIVE
            - NEUTRAL
          description: Trend outcome in market situation from broker's standpoint
          example: POSITIVE
      title: Index
    MarketIntelligence_LtrRequest:
      type: object
      properties:
        zip:
          type: string
          description: Area identifyed by zip
          example: "29634"
        date:
          type: string
          format: date
          description: Date in format ISO (YYYY-MM-DD)
          example: "2019-10-18"
        transportType:
          type: string
          enum:
            - VAN
            - REEFER
            - FLATBED
            - HOTSHOT
          description: Trailer type
          example: VAN
        location:
          type: string
          enum:
            - ORIGIN
            - DESTINATION
          description: Location type for influence calculation
          example: ORIGIN
      required:
        - zip
        - date
        - transportType
        - location
    MarketIntelligence_LtrResponse:
      type: object
      properties:
        loadsInstant:
          type: number
          description: Number of loads instant value
          example: 256
        equipmentInstant:
          type: number
          description: Number of equipment instant value
          example: 140
        loadsDerivative:
          type: number
          description: Number of loads derivative value in percent
          example: 18
        equipmentDerivative:
          type: number
          description: Number of equipment derivative value in percent
          example: -15
        ltrInstant:
          type: number
          description: Load to truck ratio instant value
          example: 6
        ltrDerivative:
          type: number
          description: Load to truck ratio derivative value in percent
          example: 12
        ltrTrend:
          type: string
          enum:
            - FLAT
            - UP
            - DOWN
          description: LTR index trend
          example: UP
        ltrTrendOutcome:
          type: string
          enum:
            - NEGATIVE
            - POSITIVE
            - NEUTRAL
          description: LTR index trend outcome in market situation for broker's standpoint
          example: POSITIVE
    MarketIntelligence_NegotiationResponse:
      type: object
      description: |
        Object with negotiation advice descriptors as properties.

        Structure is that of a map <advice_code, advice_data_object>
      properties:
        lastPaid:
          type: object
          description: >
            Last rate paid on this lane


            How we word it in our app:

            ```

            The last time we moved this load, we paid ${amount} to the ${carrier}


            Last Move: ${amount} on ${date}; ${carrier}

            ```
          properties:
            amount:
              type: number
              format: float
              description: cost
              example: 12345.67
            date:
              type: string
              format: date-time
              description: date
              example: "2020-01-13T16:00:00Z"
            days:
              type: integer
              description: Number of days used to calculate 'amount' and 'date'
              example: 30
            carrier:
              type: string
              description: Carrier name which got paid last time on this line
              example: Horns and hooves trucks
          required:
            - amount
            - date
            - days
        minPaid:
          type: object
          description: >
            Minimum rate paid on this lane


            How we word it in our app:

            ```

            The lowest we've moved this load in the last ${days} days is ${amount}


            Lowest Move: ${amount} on ${date}

            ```
          properties:
            amount:
              type: number
              format: float
              description: cost
              example: 12345.67
            date:
              type: string
              format: date-time
              description: date
              example: "2020-01-13T16:00:00Z"
            days:
              type: integer
              description: Number of days used to calculate 'amount' and 'date'
              example: 30
          required:
            - amount
            - date
            - days
        maxPaid:
          type: object
          description: |
            Maximum rate paid on this lane

            How we word it in our app:
            ```
            The most we have paid for this in the last ${days} days is ${amount}

            Max paid rate: ${amount} on ${date}
            ```
          properties:
            amount:
              type: number
              format: float
              description: cost
              example: 12345.67
            date:
              type: string
              format: date-time
              description: date
              example: "2020-01-13T16:00:00Z"
            days:
              type: integer
              description: Number of days used to calculate 'amount' and 'date'
              example: 30
          required:
            - amount
            - date
            - days
        avgShipperCost:
          type: object
          description: |
            Average shipper cost invoiced on this lane

            How we word it in our app:
            ```
            Over the last ${days} days our customer has been paying us ${amount}

            Days: ${days}. Average sell rate: ${amount}
            ```
          properties:
            amount:
              type: number
              format: float
              description: cost
              example: 12345.67
            days:
              type: integer
              description: Number of days used to calculate 'amount'
              example: 30
          required:
            - amount
            - days
        rateDiff:
          type: object
          description: |
            Difference between rates

            How we word it in our app:
            ```
            Rates are ${trendMain} by ${diff}% based on our data for this lane 
            in the last ${days} days

            Rates ${trendSub}: ${diff}%
            ```
          properties:
            diff:
              type: number
              format: float
              description: Difference between rates
              example: 12345.67
            days:
              type: integer
              description: Number of days used to calculate 'rateDiff'
              example: 30
          required:
            - diff
            - days
        laneLoadCount:
          type: object
          description: |
            Count of moves on this lane

            How we word it in our app:
            ```
            We have moved this lane ${loadCount} times in the last ${days} days

            Moves: ${loadCount}; Average rate: ${averageFlatRate}
            ```
          properties:
            loadCount:
              type: integer
              description: Number of loads on this lane during 'days'
              example: 12345
            averageFlatRate:
              type: number
              format: float
              description: Average flat rate of all loads during 'days'
              example: 12345.67
            days:
              type: integer
              description: Number of days used to calculate 'loadCount'
              example: 30
          required:
            - loadCount
            - averageFlatRate
            - days
        destinationNearHotMarket:
          type: object
          description: |
            Destination market is hot

            How we word it in our app:
            ```
            This load is delivering near a healthy market

            ${distance} to a red hot market
            ```
          properties:
            distance:
              type: number
              format: float
              description: Distance in miles from destination area to a healthy market
              example: 12345.67
          required:
            - distance
        destinationNearCarrierDomicile:
          type: object
          description: >
            Destination is near the carrier domicile


            How we word it in our app:

            ```

            It's likely that the carrier is trying to get home. Their headquarters 

            are ${distance} from delivery


            ${distance} to carrier domicile

            ```
          properties:
            distance:
              type: number
              format: float
              description: Distance in miles from destination area to carriers domicile
              example: 12345.67
          required:
            - distance
        nearTheEndOfThePeriod:
          type: object
          description: >
            This load is scheduled for pickup at the end 

            of the month / quarter / year


            How we word it in our app:

            ```

            This load is scheduled for pickup at the end of the ${period}. This 

            may increase carrier rates and make this load more difficult to cover


            End of ${period} pickup. Increased rates

            ```
          properties:
            period:
              type: string
              enum:
                - MONTH
                - FIRST_QUARTER
                - SECOND_QUARTER
                - THIRD_QUARTER
                - YEAR
              example: YEAR
          required:
            - period
        irregularBussinesHours:
          type: object
          description: |
            This load is scheduled for pickup outside of regular business hours

            How we word it in our app:
            ```
            This load is scheduled for pickup outside of regular 
            business hours (8am-6pm), this may increase carrier rates 
            and make this load more difficult to cover

            Irregular pickup hours. Increased rates
            ```
          properties:
            pickUptime:
              type: string
              format: time
              example: 43200
          required:
            - pickUptime
        holidayIsComing:
          type: object
          deprecated: true
          description: |
            A holiday was found close to the pickup date

            How we word it in our app:
            ```
            if (days < 1) {
              The pickup date is scheduled for ${holiday}. This 
              may increase carrier rates and make loads more difficult to cover
              
              ${holiday} pickup. Increased rates
            } else {
              Remember, ${holiday} is coming up in ${days} day(s). This 
              may increase carrier rates and make loads more difficult to cover
              
              ${holiday} pickup. Increased rates
            }
            ```

            **deprecated** - use `comingEvents` instead
          properties:
            days:
              type: integer
              example: 3
            holiday:
              type: string
              enum:
                - CHRISTMAS
                - NEW_YEAR
                - MEMORIAL_DAY
                - WASHINGTONS_BIRTHDAY
                - MARTIN_LUTHER_KING
                - VETERANS_DAY
                - LABOR_DAY
                - INDEPENDENCE_DAYS
                - JUNETEENTH_INDEPENDENCE_DAY
                - COLUMBUS_DAY
                - THANKSGIVING
                - EASTER_WEEKEND
                - VICTORIA_DAY
                - CANADA_DAY
                - PROVINCIAL_DAY
                - NATIONAL_DAY_FOR_TRUTH_AND_RECONCILIATION
                - REMEMBRANCE_DAY
              example: CHRISTMAS
          required:
            - holiday
            - days
        inspectionWeeks:
          type: object
          deprecated: true
          description: |
            Pickup date is during inspection weeks

            How we word it in our app:
            ```
            The pickup date is scheduled for ${week}. This 
            may increase carrier rates and make loads more difficult to cover

            ${week} pickup. Increased rates
            ```

            **deprecated** - use `comingEvents` instead
          properties:
            name:
              type: string
              enum:
                - INTERNATIONAL_ROADCHECK
                - OPERATION_SAFE_DRIVER
                - BRAKE_SAFETY_WEEK
              example: BRAKE_SAFETY_WEEK
          required:
            - name
        comingEvents:
          type: array
          description: |
            A list of events that are beginning soon after the pickup date
            e.g. holidays or inspection weeks
          items:
            $ref: "#/components/schemas/MarketIntelligence_ComingEvent"
        originLtrLow:
          type: object
          deprecated: true
          description: Deprecated
          properties:
            ltr:
              type: number
              format: float
              description: Origin area LTR
              example: 12345.67
          required:
            - ltr
        destinationLtrHigh:
          type: object
          deprecated: true
          description: Deprecated
          properties:
            ltr:
              type: number
              format: float
              description: Destination area LTR
              example: 12345.67
          required:
            - ltr
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217
          example: USD
    MarketIntelligence_ComingEvent:
      type: object
      description: |
        A descriptor of an event that is beginning soon after the pickup date
      properties:
        name:
          type: string
          description: |
            Human readable name of the event 
            e.g. a holiday called 'Washington's Birthday'
          example: Washington's Birthday
        daysToBeginning:
          type: integer
          description: |
            The number of days left until the beginning of the event 
            starting from the pick up date
          example: 3
      required:
        - name
        - daysToBeginning
    MarketIntelligence_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    MarketIntelligence_ResponseMessage:
      type: object
      properties:
        commonResponse:
          type: string
          x-enum-varnames:
            - not_readable_message
            - access_forbidden
            - item_not_found
            - request_timeout
            - request_validation
            - parse_error
            - internal_error
            - access_forbidden_companyId
            - method_not_allowed
            - missing_required_parameter
          enum:
            - "Body request is not readable : %s"
            - Access is forbidden
            - Item not found
            - Request timeout after {} sec
            - You have one or more errors in request structure
            - "Text '%s' could not be parsed in field: %s"
            - Internal server error
            - companyId in JWT token is not equals importCompanyId in request
              body
            - Method not allowed
            - Missing required parameter
        serviceResponse:
          type: string
    Prediction_PredictionFilterBatchRatesRequest:
      type: object
      properties:
        responses:
          type: array
          description: list of PredictionRatesResponses
          items:
            $ref: "#/components/schemas/Prediction_PredictionRatesResponse"
        requests:
          type: array
          description: list of PredictionRatesRequest
          items:
            $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
        companyId:
          type: string
          description: Company Id
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
      required:
        - responses
        - requests
        - companyId
    Prediction_PredictionFilterBatchRatesResponse:
      type: object
      properties:
        responses:
          type: array
          description: list of PredictionInternalRatesResponse after filters
          items:
            $ref: "#/components/schemas/Prediction_PredictionInternalRatesResponse"
      required:
        - responses
    Prediction_PredictionBatchRatesRequest:
      type: object
      properties:
        requests:
          type: array
          description: List of prediction requests
          maxItems: 1000
          items:
            $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
      required:
        - requests
    Prediction_PredictionBatchRatesResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of prediction responses
          items:
            $ref: "#/components/schemas/Prediction_PredictionBatchRatesObject"
      required:
        - responses
    Prediction_PredictionRatesRequest:
      type: object
      x-parent: true
      properties:
        pickupDateTime:
          type: string
          format: date-time
          description: |
            Load pick up date and time in ISO date format. Time zone is ignored.

            **Earliest allowed** pickup date is 2015-01-01T00:00:00Z.
          example: "2021-09-21T13:00:00Z"
        transportType:
          $ref: "#/components/schemas/Prediction_TransportType"
        stops:
          $ref: "#/components/schemas/Prediction_RateStopArray"
        commodity:
          type: string
          description: Commodity description in free form
          example: Racks
        tag:
          type: string
          description: >
            An optional parameter that can be used to identify the prediction
            response
          example: Pro#1234
        currency:
          type: string
          description: >
            Code of the currency that you want the response to be in. 

            Format is ISO 4217. 


            If not provided, defaults to the currency set in the profile of currently authenticated user.
          example: USD
      required:
        - pickupDateTime
        - transportType
        - stops
    Prediction_PredictionRatesResponse:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesObject"
    Prediction_PredictionHistoryResponse:
      type: object
      description: Contains a list of prediction requests and their responses
      properties:
        items:
          type: array
          description: List of prediction requests and their responses
          items:
            $ref: "#/components/schemas/Prediction_PredictionHistoryResponseItem"
      required:
        - items
    Prediction_PredictionHistoryResponseItem:
      type: object
      properties:
        id:
          type: string
          description: Prediction id in the form of an UUID
          example: 83e60ba0-389c-401a-8a7a-a879a2838d6e
        dateTime:
          type: string
          format: date-time
          description: Date and time when the request was made
          example: "2021-09-21T13:00:00Z"
        userEmail:
          type: string
          description: Email of the user that made the rate request
          example: test@carrier.com
        transportType:
          $ref: "#/components/schemas/Prediction_TransportType"
        originCity:
          type: string
          description: Origin city
          example: Chicago
        originState:
          type: string
          description: Origin state
          example: IL
        originZip:
          type: string
          description: Origin zip
          example: "60636"
        destinationCity:
          type: string
          description: Destination city
          example: Houston
        destinationState:
          type: string
          description: Destination state
          example: TX
        destinationZip:
          type: string
          description: Destination zip
          example: "73264"
        pickupDateTime:
          type: string
          format: date-time
          description: Load pick up date and time in ISO date format
          example: "2021-09-21T13:00:00Z"
        tag:
          type: string
          description: Rate request tag
          example: Pro#1234
        currency:
          type: string
          description: Requested currency. Format is ISO 4217.
          example: USD
        targetBuyRate:
          type: number
          description: Target buy rate (per mile, fuel included).
          example: 2.24
        lowBuyRate:
          type: number
          description: Low boundary of the buy rate (per mile, fuel included)
          example: 2.11
        highBuyRate:
          type: number
          description: High boundary of the buy rate (per mile, fuel included)
          example: 2.5
        startBuyRate:
          type: number
          description: |
            Suggested starting buy rate 
            for negotiations with the carrier (per mile, fuel included)
          example: 2.07
        distance:
          type: number
          description: Total distance of the trip (in miles)
          example: 289
        confidenceLevel:
          type: integer
          minimum: 0
          maximum: 100
          description: |
            How confident the system is in the prediction it is making. 

            From 0 - lowest possible confidence\
            To 100 - highest possible confidence
          example: 65
        notes:
          $ref: "#/components/schemas/Prediction_RateNotes"
      required:
        - id
        - dateTime
        - userEmail
        - transportType
        - originCity
        - originState
        - destinationCity
        - destinationState
        - pickupDateTime
        - tag
        - currency
        - targetBuyRate
        - lowBuyRate
        - highBuyRate
        - startBuyRate
        - distance
        - confidenceLevel
    Prediction_PredictionInternalRatesResponse:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesObject"
        - type: object
          properties:
            targetBuyRateMl:
              type: number
              description: buy flat rate for requested lane with included fuel $/mi returned
                model
              example: 2.24
            lowBuyRateMl:
              type: number
              description: low border for Buy rate $/mi returned model
              example: 2.11
            highBuyRateMl:
              type: number
              description: high border for Buy rate $/mi returned model
              example: 2.5
      required:
        - id
        - targetBuyRate
        - startBuyRate
        - lowBuyRate
        - highBuyRate
        - distance
        - confidenceLevel
        - acceptanceRates
        - tag
        - currency
        - targetBuyRateMl
        - lowBuyRateMl
        - highBuyRateMl
    Prediction_PredictionInternalBatchRatesResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of prediction responses
          items:
            $ref: "#/components/schemas/Prediction_PredictionInternalBatchRatesObject"
      required:
        - responses
    Prediction_PredictionInternalBatchRatesObject:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionBatchRatesObject"
        - type: object
          properties:
            targetBuyRateMl:
              type: number
              description: Raw ML model target buy rate before any adjustments
              example: 2.24
            lowBuyRateMl:
              type: number
              description: Raw ML model low buy rate before any adjustments
              example: 2.11
            highBuyRateMl:
              type: number
              description: Raw ML model high buy rate before any adjustments
              example: 2.5
            biasAdjustmentFactor:
              type: number
              description: Applied bias adjustment factor, if any. Negative means rate was
                reduced (model was overpredicting), positive means rate was
                increased (model was underpredicting). Applied as adjusted_rate
                = model_rate * (1 + biasAdjustmentFactor).
              example: -0.0375
    Prediction_PredictionRatesObject:
      type: object
      x-parent: true
      properties:
        id:
          type: string
          description: Prediction id in the form of an UUID
          example: 83e60ba0-389c-401a-8a7a-a879a2838d6e
        targetBuyRate:
          type: number
          description: Target buy rate (per mile, fuel included).
          example: 2.24
        lowBuyRate:
          type: number
          description: Low boundary of the buy rate (per mile, fuel included)
          example: 2.11
        highBuyRate:
          type: number
          description: High boundary of the buy rate (per mile, fuel included)
          example: 2.5
        startBuyRate:
          type: number
          description: |
            Suggested starting buy rate 
            for negotiations with the carrier (per mile, fuel included)
          example: 2.07
        fuelRate:
          type: number
          description: Fuel surcharge (per mile)
          example: 0.33
        distance:
          type: number
          description: Total distance of the trip (in miles)
          example: 289
        confidenceLevel:
          type: integer
          minimum: 0
          maximum: 100
          description: |
            How confident the system is in the prediction it is making. 

            From 0 - lowest possible confidence\
            To 100 - highest possible confidence
          example: 65
        acceptanceRates:
          type: array
          items:
            type: number
          description: >
            List of buy rates (per mile). Each rate should be thought of as a
            rate at which

            the chance of carrier accepting it is X%. X ranges from 0% to 100%, and

            the rates are equally distributed between and including 0% and 100%.


            For example 11 items in this array would mean 11 rates at which the chance

            of carrier acceptance is [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100] percent.


            Might be empty if acceptance rates could not be calculated.
        tag:
          type: string
          description: |
            Tag for prediction identification. 

            If you passed a tag parameter in the request body, 
            it will have the same value as in the request. 

            If not, then it will be generated by us.
          example: 78206219-883b-4e1a-bd42-4010d3cc21c1
        currency:
          type: string
          description: The currency that the prediction values are in (ISO 4217 format)
          example: USD
        notes:
          $ref: "#/components/schemas/Prediction_RateNotes"
      required:
        - id
        - targetBuyRate
        - startBuyRate
        - lowBuyRate
        - highBuyRate
        - distance
        - confidenceLevel
        - acceptanceRates
        - tag
        - currency
    Prediction_PredictionBatchRatesObject:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesObject"
        - type: object
          properties:
            status:
              type: string
              enum:
                - OK
                - ERROR
              description: Prediction status
              example: OK
            errorObject:
              $ref: "#/components/schemas/Prediction_ErrorObject"
      required:
        - status
    Prediction_PredictionRatesSpecialties:
      type: object
      description: Transport type specialties
      properties:
        hotshot:
          type: boolean
          description: Signifies whether a hotshot rate is requested
          example: true
    Prediction_PredictionRatesInternalRequest:
      type: object
      description: An internal version of PredictionRatesRequest with additional fields
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
        - type: object
          properties:
            specialties:
              $ref: "#/components/schemas/Prediction_PredictionRatesSpecialties"
    Prediction_PredictionBatchRatesInternalRequest:
      type: object
      properties:
        requests:
          type: array
          description: List of prediction requests
          maxItems: 1000
          items:
            $ref: "#/components/schemas/Prediction_PredictionRatesInternalRequest"
      required:
        - requests
    Prediction_PredictionTFXRatesRequest:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesRequest"
        - type: object
          properties:
            postedRate:
              type: number
              description: rate the load is posted for
              example: 2.07
            externalLoadId:
              type: string
              description: the identifier for this load in the requesting system
    Prediction_PredictionTFXRatesResponse:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionTFXRatesObject"
      required:
        - id
        - targetBuyRate
        - startBuyRate
        - lowBuyRate
        - highBuyRate
        - distance
        - confidenceLevel
        - acceptanceRates
        - tag
        - currency
        - postedRateAssessment
    Prediction_PredictionTFXRatesObject:
      x-parent: true
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionRatesObject"
        - type: object
          properties:
            postedRateAssessment:
              $ref: "#/components/schemas/Prediction_PredictionTFXPostedRateAssessment"
    Prediction_PredictionTFXBatchRatesRequest:
      type: object
      properties:
        requests:
          type: array
          description: List of prediction requests
          maxItems: 1000
          items:
            $ref: "#/components/schemas/Prediction_PredictionTFXRatesRequest"
      required:
        - requests
    Prediction_PredictionTFXBatchRatesResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of prediction responses
          items:
            $ref: "#/components/schemas/Prediction_PredictionTFXBatchRatesObject"
      required:
        - responses
    Prediction_PredictionTFXBatchRatesObject:
      allOf:
        - $ref: "#/components/schemas/Prediction_PredictionTFXRatesObject"
        - type: object
          properties:
            status:
              type: string
              enum:
                - OK
                - ERROR
              description: Prediction status
              example: OK
            errorObject:
              $ref: "#/components/schemas/Prediction_ErrorObject"
      required:
        - status
    Prediction_PredictionTFXPostedRateAssessment:
      type: string
      enum:
        - ""
        - Fair
        - Good
        - Great
    Prediction_RateStopArray:
      type: array
      description: List of load stops
      minItems: 2
      items:
        $ref: "#/components/schemas/Prediction_RateStop"
      example:
        - order: 0
          country: US
          city: Chicago
          state: IL
          zip: "60611"
        - order: 1
          country: US
          city: Dallas
          state: TX
          zip: "75204"
    Prediction_RateStop:
      type: object
      description: Load stop data
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        city:
          type: string
          description: City name
          example: Chicago
        state:
          type: string
          description: Two letter state code
          example: IL
        zip:
          type: string
          description: >
            Zip code. 


            *Not required, but should be provided if possible, as it will improve prediction accuracy.*
          example: "60636"
      example:
        order: 0
        country: US
        city: Chicago
        state: IL
        zip: "60611"
      required:
        - order
        - city
        - state
    Prediction_RateNotes:
      type: object
      description: >
        Map of notes about the rate. 

        This is used to return additional information (notes/comments) about the rate, 

        that is difficult to convey otherwise.


        If a property of this object is present and it's value is not null 

        then the note is considered applicable
      properties:
        shortHaulRateInaccurate:
          type: object
          description: |
            Signifies that the predicted rate might be inaccurate 
            because short hauls, are not supported well
          properties:
            distanceLessThan:
              type: number
              description: |
                A load is considered a Short Haul 
                if it's mileage is lower than this number
              example: 30
          required:
            - distanceLessThan
        multistopDistanceOutlierRateInaccurate:
          type: object
          description: >
            Signifies that the predicted rate might be inaccurate 

            because multistop hauls with distance much bigger or less than 

            the distance for the same lane single stop haul, are not supported well
          properties:
            allowedDistanceDifferenceRange:
              type: object
              description: >
                Describes the range of distance values that should not trigger
                this warning.

                Anything outside the minimum and the maximum 

                will be considered inaccurate. And will trigger this warning as a result
              properties:
                minimumPercentage:
                  type: number
                  description: |
                    Minimum distance difference percentage 
                    allowed for the prediction to be considered accurate.
                    If not present then there is no lower bound
                  example: 0
                maximumPercentage:
                  type: number
                  description: |
                    Maximum distance difference percentage
                    allowed for the prediction to be considered accurate.
                    If not present then there is no upper bound
                  example: 100
            singleStopDistance:
              type: number
              description: Distance (in miles) of a single stop haul for the same lane
              example: 570
          required:
            - allowedDistanceDifferenceRange
            - singleStopDistance
    Prediction_ErrorObject:
      type: object
      description: Error/Exception description
      properties:
        httpCode:
          type: integer
          description: Response code
          example: 424
        code:
          type: string
          description: unique string identifier of the error
          example: not_found_distance
        message:
          type: string
          description: Readable error message
          example: Not found route between locations
      required:
        - httpCode
        - code
        - message
    Prediction_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    Prediction_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    Prediction_Error422UnprocessableEntityMulti:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        errors:
          type: array
          description: list of errors
          items:
            type: object
            description: Request validation error
            properties:
              field:
                type: string
                description: Name of the field that did not pass validation
                example: transportType
              message:
                type: string
                description: Human readable error mesage explaining why validation failed
                example: SpaceXDragon transportType is not supported. Valid values are [VAN,
                  FLATBED, ...]
              value:
                type: string
                nullable: true
                description: Value of the field that did not pass validation
                example: SpaceXDragon
            required:
              - field
              - message
      required:
        - code
        - message
        - errors
      example:
        code: request_validation
        message: You have one or more errors in request structure
        errors:
          - field: carrierName
            message: field contains wrong data type (int), should be string
            value: "22"
          - field: shipperId
            message: "shipperId: must not be null"
            value: null
          - field: loadSource.loadId
            message: "loadId: must not be null"
            value: null
    Prediction_ResponseMessage:
      type: object
      properties:
        commonResponse:
          type: string
          x-enum-varnames:
            - not_readable_message
            - access_forbidden
            - item_not_found
            - request_timeout
            - request_validation
            - parse_error
            - internal_error
            - access_forbidden_companyId
            - method_not_allowed
            - missing_required_parameter
          enum:
            - "Body request is not readable : %s"
            - Access is forbidden
            - Item not found
            - Request timeout after {} sec
            - You have one or more errors in request structure
            - "Text '%s' could not be parsed in field: %s"
            - Internal server error
            - companyId in JWT token is not equals importCompanyId in request
              body
            - Method not allowed
            - Missing required parameter
        serviceResponse:
          type: string
    Pricing_PricingStatistics:
      type: object
      description: Statistical pricing percentages based on your historical load data
      properties:
        average:
          type: number
          description: Average pricing percentage
          example: 11
        minimum:
          type: number
          description: Minimum pricing percentage
          example: 10
        maximum:
          type: number
          description: Maximum pricing percentage
          example: 13
      required:
        - average
        - minimum
        - maximum
    Pricing_PricingStatisticsCalculation:
      type: object
      description: |
        Contains historical pricing statistics 
        and if possible a calculated `targetSellCost`
      properties:
        pricing:
          $ref: "#/components/schemas/Pricing_PricingStatistics"
        targetSellCost:
          type: number
          example: 1250
          description: |
            Flat target sell cost calculated by applying the rule
            to the provided flat buy cost
      required:
        - pricing
    Pricing_PricingPriorityRuleRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the rule
          example: Customer`s rule
        priority:
          type: integer
          description: Priority of the rule
          example: 3
        active:
          type: boolean
          description: Status of the rule
          example: false
        conditions:
          $ref: "#/components/schemas/Pricing_RuleRequestConditions"
        effects:
          $ref: "#/components/schemas/Pricing_PriorityRuleEffectsInput"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
      required:
        - name
        - priority
        - active
        - conditions
        - effects
    Pricing_RuleRequestConditions:
      type: object
      description: |
        Conditions in which this rule is applicable.

        When multuple conditions are provided the rule is only applied 
        if all of them are met.
      properties:
        commodity:
          type: array
          description: >
            List of commodities to which the rule is applicable.

            At least one commodity from this list has to match for the rule to apply
          items:
            type: string
          example:
            - Apples
        confidenceLevel:
          $ref: "#/components/schemas/Pricing_ConfidenceLevelRange"
        customers:
          type: array
          description: >
            List of customers to which the rule is applicable. 

            At least one customer from this list has to match for the rule to apply.
          items:
            type: string
            description: Customer name
          example:
            - LTR and Co
            - CocaCola
            - Walmart
        lanes:
          type: array
          description: |
            List of lanes to which the rule is applicable. 
            At least one lane from this list has to match for the rule to apply.
          items:
            $ref: "#/components/schemas/Pricing_RuleRequestLane"
        lengthOfHaul:
          $ref: "#/components/schemas/Pricing_LengthOfHaulRange"
        matchingTime:
          $ref: "#/components/schemas/Pricing_MatchingTimeRange"
        transitTime:
          $ref: "#/components/schemas/Pricing_TransitTimeRange"
        transportTypes:
          type: array
          maxItems: 3
          description: >
            List of transport types to which the rule is applicable.

            At least one transport type from this list has to match for the rule to apply
          items:
            $ref: "#/components/schemas/Pricing_TransportType"
        users:
          type: array
          description: |
            List of users to whom the rule is applicable. 
            At least one user from this list has to match for the rule to apply
          items:
            type: string
        weight:
          $ref: "#/components/schemas/Pricing_WeightRange"
        stopsCount:
          $ref: "#/components/schemas/Pricing_StopsCountRange"
        mileageDifference:
          $ref: "#/components/schemas/Pricing_MileageDifferenceRange"
    Pricing_RuleRequestLane:
      type: object
      description: A lane that the rule is applicable to
      properties:
        origins:
          $ref: "#/components/schemas/Pricing_RuleRequestLocations"
        destinations:
          $ref: "#/components/schemas/Pricing_RuleRequestLocations"
      required:
        - origins
        - destinations
    Pricing_RuleRequestLocations:
      type: array
      description: A list of locations that the rule is applicable to
      items:
        $ref: "#/components/schemas/Pricing_RuleRequestLocation"
      example:
        - type: ANYWHERE
        - type: STATE
          country: US
          state: IL
        - type: CITY
          country: US
          state: IL
          city: Chicago
        - type: MARKET
          country: US
          marketCode: NY_ALB
    Pricing_RuleRequestLocation:
      type: object
      description: Lane stop
      properties:
        type:
          type: string
          enum:
            - ANYWHERE
            - STATE
            - CITY
            - MARKET
          example: ANYWHERE
          description: |
            The location type. 

            For type ANYWHERE no fields are required.

            For type STATE - "country" and "state" fields are required.

            For type CITY - "country", "state" and "city" fields are required.

            For type MARKET - "country" and "marketCode" fields are required.
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
        marketCode:
          type: string
          description: Market code
          example: NY_ALB
      required:
        - type
    Pricing_PriorityRuleCalculation:
      type: object
      description: |
        Contains an applicable priority rule 
        and if possible a calculated `targetSellCost`
      properties:
        rule:
          $ref: "#/components/schemas/Pricing_PriorityRule"
        targetSellCost:
          type: number
          example: 1250
          description: |
            Flat target sell cost calculated by applying the rule
            to the provided flat buy cost
      required:
        - rule
    Pricing_PricingCombinationRuleRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the rule
          example: Customer`s rule
        active:
          type: boolean
          description: Status of the rule
          example: false
        conditions:
          $ref: "#/components/schemas/Pricing_RuleRequestConditions"
        effects:
          $ref: "#/components/schemas/Pricing_CombinationRuleEffectsInput"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
      required:
        - name
        - active
        - conditions
        - effects
    Pricing_CombinationRulesCalculation:
      type: object
      description: >
        Contains applicable combination rules and if possible a calculated
        `targetSellCost`
      properties:
        rules:
          type: array
          description: List of applicable combination rules
          items:
            $ref: "#/components/schemas/Pricing_CombinationRule"
        targetSellCost:
          type: number
          example: 1250
          description: |
            Flat target sell cost calculated by applying combination rules 
            to the provided flat buy cost
      required:
        - rules
    Pricing_PricingCombinationRulesResponse:
      type: object
      properties:
        rules:
          type: array
          description: List of combination rules
          items:
            $ref: "#/components/schemas/Pricing_CombinationRule"
      required:
        - rules
    Pricing_PricingPriorityRulesResponse:
      type: object
      properties:
        rules:
          type: array
          description: List of rules
          items:
            $ref: "#/components/schemas/Pricing_PriorityRule"
      required:
        - rules
    Pricing_Stops:
      type: array
      description: A list of stops
      minItems: 2
      maxItems: 12
      items:
        $ref: "#/components/schemas/Pricing_Stop"
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
    Pricing_Stop:
      type: object
      description: Contains the stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
          minimum: 0
        address:
          $ref: "#/components/schemas/Pricing_Address"
      required:
        - order
        - address
    Pricing_Address:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
        zip:
          type: string
          description: Zip
          example: "12345"
      required:
        - country
    Pricing_PricingResponse:
      type: object
      description: A collection of all the pricing options found
      properties:
        default:
          $ref: "#/components/schemas/Pricing_DefaultPricingCalculation"
        laneHistorical:
          $ref: "#/components/schemas/Pricing_PricingStatisticsCalculation"
        customerHistorical:
          $ref: "#/components/schemas/Pricing_PricingStatisticsCalculation"
        customerOnLaneHistorical:
          $ref: "#/components/schemas/Pricing_PricingStatisticsCalculation"
        priorityRule:
          $ref: "#/components/schemas/Pricing_PriorityRuleCalculation"
        combinationRules:
          $ref: "#/components/schemas/Pricing_CombinationRulesCalculation"
        suggested:
          $ref: "#/components/schemas/Pricing_SuggestedPricing"
        currency:
          type: string
          description: >
            Code of the currency of any monetary values in the response. 


            **Except flat pricing effect descriptors**, those have their own currencies. 


            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - currency
    Pricing_PricingRequest:
      type: object
      description: A set of fields used during pricing calculation
      properties:
        transportType:
          $ref: "#/components/schemas/Pricing_TransportType"
        stops:
          $ref: "#/components/schemas/Pricing_Stops"
        region:
          $ref: "#/components/schemas/Pricing_GeographicalAreaLane"
        customerName:
          type: string
          description: Customer name
          example: Test Customer
        pickupDate:
          type: string
          format: date-time
          description: Pick up date in time zone of origin
          example: "2020-01-13T16:00:00Z"
        deliveryDate:
          type: string
          format: date-time
          description: Delivery date in time zone of the destination
          example: "2020-01-13T16:00:00Z"
        weight:
          type: number
          format: float
          description: Weight of the cargo in lb
          example: 10000
        commodity:
          type: string
          description: Name of the commodity
          example: Apples
        targetBuyCost:
          type: number
          description: >
            The flat buy cost that the calculated pricing effect will be applied
            to, 

            in order to calculate the flat target sell cost
          example: 1000
        confidenceLevel:
          type: integer
          minimum: 0
          maximum: 100
          description: |
            Buy rate prediction confidence level 
            from the rate prediction endpoint response
          example: 65
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
    Pricing_PricingMarketplaceMyBrokerPartnersRequest:
      type: object
      description: Data needed for calculating sell costs for a given lane
      properties:
        transportType:
          $ref: "#/components/schemas/Pricing_TransportType"
        stops:
          $ref: "#/components/schemas/Pricing_Stops"
        region:
          $ref: "#/components/schemas/Pricing_GeographicalAreaLane"
        customerName:
          type: string
          description: Customer name
          example: Test Customer
        pickupDate:
          type: string
          format: date-time
          description: Pick up date in time zone of origin
          example: "2020-01-13T16:00:00Z"
        deliveryDate:
          type: string
          format: date-time
          description: Delivery date in time zone of the destination
          example: "2020-01-13T16:00:00Z"
        weight:
          type: number
          format: float
          description: Weight of the cargo in lb
          example: 10000
        commodity:
          type: string
          description: Name of the commodity
          example: Apples
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
      required:
        - transportType
        - stops
        - pickupDateTime
    Pricing_PricingMarketplaceMyBrokerPartnersResponse:
      type: object
      description: A response with a list of brokers and their sell rates
      properties:
        brokers:
          type: array
          description: |
            Array of brokers that signified that they want to work with you
            (participate in your marketplace)
          items:
            $ref: "#/components/schemas/Pricing_PricingMarketplaceMyBrokerPartnersResponseB\
              roker"
        currency:
          type: string
          description: |
            Code of the currency of any monetary values in the response. 

            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - brokers
        - currency
    Pricing_PricingMarketplaceMyBrokerPartnersResponseBroker:
      type: object
      description: A broker rate descriptor
      properties:
        mc:
          type: string
          description: Freight broker MC number
          example: MC00334234
        targetSellCost:
          type: number
          example: 1250
          description: >
            Flat target sell cost that this broker is willing to handle the load
            for
      required:
        - mc
        - targetSellCost
    Pricing_DefaultPricingCalculation:
      type: object
      description: |
        Contains the default pricing effects 
        and if possible a calculated `targetSellCost`
      properties:
        effects:
          $ref: "#/components/schemas/Pricing_DefaultPricingEffects"
        targetSellCost:
          type: number
          example: 1250
          description: >
            Flat target sell cost calculated by applying the default pricing
            effects

            to the provided flat buy cost
      required:
        - effects
    Pricing_SuggestedPricing:
      type: object
      description: >
        The pricing that we suggest to be used on this lane.


        This is based off of all the other pricing options found and 

        calculated using a priority algorithm. You can either trust us and use this

        to do your quote pricing, or you can choose from any of the other fields

        available in the response
      properties:
        name:
          type: string
          enum:
            - default
            - laneHistorical
            - customerHistorical
            - customerOnLaneHistorical
            - priorityRule
            - combinationRules
          description: |
            The name of the pricing option suggested to be used.

            The values are the names of the other fields of the response.
          example: priorityRule
        targetSellCost:
          type: number
          example: 1250
          description: >
            Flat target sell cost calculated by applying the suggested pricing
            effect 

            to the provided flat buy cost
      required:
        - name
    Pricing_CombinationRuleEffectsInput:
      type: object
      description: |
        The effects this rule will have on the price calculation.

        __Only one effect is allowed per rule__
      properties:
        percentageAdjustment:
          $ref: "#/components/schemas/Pricing_PercentageAdjustmentEffect"
        flatAdjustment:
          $ref: "#/components/schemas/Pricing_FlatAdjustmentEffectInput"
    Pricing_FlatAdjustmentEffectInput:
      type: object
      description: |
        In the default interpretation this effect increases the buy cost
        by a flat `amount` of the specified `currency` to get the sell cost
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount by which the buy cost should be increased
          example: 15
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
      required:
        - amount
    Pricing_RatePerMileAdjustmentEffectInput:
      type: object
      description: |
        In the default interpretation this effect increases the buy rate
        by an `amount` of the specified `currency` to get the sell cost
      properties:
        amount:
          type: number
          description: |
            The monetary amount by which the buy rate should be increased
          example: 0.15
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
      required:
        - amount
    Pricing_SetSellCostEffectInput:
      type: object
      description: |
        In the default interpretation this effect 
        sets the specified `amount` of the specified `currency` 
        as the final sell cost
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount to set as the sell cost
          example: 15
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
      required:
        - amount
    Pricing_SetRatePerMileEffectInput:
      type: object
      description: |
        In the default interpretation this effect 
        sets the specified `amount` of the specified `currency` 
        as the final sell rate per mile
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount to set as the sell rate per mile
          example: 3.15
        currency:
          $ref: "#/components/schemas/Pricing_Currency"
      required:
        - amount
    Pricing_PriorityRuleEffectsInput:
      type: object
      description: |
        The effects this rule will have on the price calculation.

        __Only one effect is allowed per rule__
      properties:
        percentageAdjustment:
          $ref: "#/components/schemas/Pricing_PercentageAdjustmentEffect"
        flatAdjustment:
          $ref: "#/components/schemas/Pricing_FlatAdjustmentEffectInput"
        setSellCost:
          $ref: "#/components/schemas/Pricing_SetSellCostEffectInput"
    Pricing_Currency:
      type: string
      enum:
        - USD
        - CAD
      description: |
        Currency code in ISO 4217 format (three letter code, e.g. USD)

        _If not provided, defaults to the currency set in the profile 
        of currently authenticated user (or currently authenticated company 
        if there is no user or user profile setting)_
      example: USD
    Pricing_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    Pricing_Error422UnprocessableEntityMulti:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        errors:
          type: array
          description: list of errors
          items:
            $ref: "#/components/schemas/Pricing_RequestValidationError"
      required:
        - code
        - message
        - errors
      example:
        code: request_validation
        message: You have one or more errors in request structure
        errors:
          - field: carrierName
            message: field contains wrong data type (int), should be string
            value: "22"
          - field: shipperId
            message: "shipperId: must not be null"
            value: null
          - field: loadSource.loadId
            message: "loadId: must not be null"
            value: null
    Pricing_RequestValidationError:
      type: object
      description: Request validation error
      properties:
        field:
          type: string
          description: Name of the field that did not pass validation
          example: transportType
        message:
          type: string
          description: Human readable error mesage explaining why validation failed
          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
            FLATBED, ...]
        value:
          type: string
          nullable: true
          description: Value of the field that did not pass validation
          example: SpaceXDragon
      required:
        - field
        - message
    Pricing_PricingTypeGroup:
      type: string
      description: |
        How this shipment was priced to the shipper in the following groupings
        (CONTRACT, SPOT, or OTHER)
      enum:
        - CONTRACT
        - SPOT
        - OTHER
      example: SPOT
    Pricing_PricingRuleGroup:
      type: string
      description: Pricing rule group filter. If not specified, all rules are returned.
      enum:
        - SPOT
        - CONTRACT
    Pricing_TransportType:
      type: string
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
      description: >
        Transport type


        If you would like Hotshot predictions, reach out to your CSM and DA. 

        The model will not work properly without your hotshot data effectively filtered and imported into the model.
      example: VAN
    Pricing_GeographicalAreaLane:
      type: string
      enum:
        - CITY
        - CITY_ZIP
        - ZIP_CITY
        - ZIP
      description: >
        Determines the size of the area around origin and destination points, 

        that will be searched for the related data.

        * CITY - narrow, city wide, area

        * ZIP - narrow, five digit zip, area

        * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

        * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
      example: ZIP
    Pricing_PriorityRuleEffects:
      type: object
      description: The effects this rule will have on the price calculation
      properties:
        percentageAdjustment:
          $ref: "#/components/schemas/Pricing_PercentageAdjustmentEffect"
        flatAdjustment:
          $ref: "#/components/schemas/Pricing_FlatAdjustmentEffect"
        setSellCost:
          $ref: "#/components/schemas/Pricing_SetSellCostEffect"
    Pricing_CombinationRuleEffects:
      type: object
      description: The effects this rule will have on the price calculation
      properties:
        percentageAdjustment:
          $ref: "#/components/schemas/Pricing_PercentageAdjustmentEffect"
        flatAdjustment:
          $ref: "#/components/schemas/Pricing_FlatAdjustmentEffect"
    Pricing_DefaultPricingEffects:
      type: object
      description: >
        The default pricing effects that are to be used for the sell cost
        calculation

        if no other pricing options are found
      properties:
        percentageAdjustment:
          $ref: "#/components/schemas/Pricing_PercentageAdjustmentEffect"
        flatAdjustment:
          $ref: "#/components/schemas/Pricing_FlatAdjustmentEffect"
        setSellCost:
          $ref: "#/components/schemas/Pricing_SetSellCostEffect"
    Pricing_PercentageAdjustmentEffect:
      type: object
      description: |
        In the default interpretation this effect marks up the buy cost
        by some `percentage` to get the sell cost
      properties:
        percentage:
          type: number
          description: The percentage by which the buy cost should be marked up
          example: 15
      required:
        - percentage
    Pricing_FlatAdjustmentEffect:
      type: object
      description: |
        In the default interpretation this effect increases the buy cost
        by a flat `amount` of the specified `currency` to get the sell cost
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount by which the buy cost should be increased
          example: 15
        currency:
          type: string
          description: |
            Code of the currency used in this effect.
            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - amount
        - currency
    Pricing_RatePerMileAdjustmentEffect:
      type: object
      description: |
        In the default interpretation this effect increases the buy rate
        by an `amount` of the specified `currency` to get the sell rate
      properties:
        amount:
          type: number
          description: |
            The monetary amount by which the buy rate should be increased
          example: 0.5
        currency:
          type: string
          description: |
            Code of the currency used in this effect.
            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - amount
        - currency
    Pricing_SetSellCostEffect:
      type: object
      description: |
        In the default interpretation this effect 
        sets the specified `amount` of the specified `currency` 
        as the final sell cost
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount to set as the sell cost
          example: 15
        currency:
          type: string
          description: |
            Code of the currency used in this effect.
            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - amount
        - currency
    Pricing_SetRatePerMileEffect:
      type: object
      description: |
        In the default interpretation this effect 
        sets the specified `amount` of the specified `currency` 
        as the final rate per mile
      properties:
        amount:
          type: number
          description: |
            The flat monetary amount to set as the sell rate per mile
          example: 3.5
        currency:
          type: string
          description: |
            Code of the currency used in this effect.
            Format is ISO 4217 (a three letter code e.g. 'USD')
          example: USD
      required:
        - amount
        - currency
    Pricing_ConfidenceLevelRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_IntegerRange"
      description: >
        Confidence level range to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: integer
          description: Minimum confidence level in miles
          minimum: 0
          maximum: 100
          example: 70
        to:
          type: integer
          description: Maximum confidence level in miles
          minimum: 0
          maximum: 100
          example: 100
    Pricing_RuleLane:
      type: object
      description: Lane description object
      properties:
        origins:
          $ref: "#/components/schemas/Pricing_RuleLocations"
        destinations:
          $ref: "#/components/schemas/Pricing_RuleLocations"
      required:
        - origins
        - destinations
    Pricing_RuleLocations:
      type: array
      description: A list of locations that the rule is applicable to
      items:
        $ref: "#/components/schemas/Pricing_RuleLocation"
      example:
        - type: ANYWHERE
        - type: STATE
          country: US
          state: IL
        - type: CITY
          country: US
          state: IL
          city: Chicago
        - type: MARKET
          country: US
          marketCode: NY_ALB
          marketName: Albany Market
    Pricing_RuleLocation:
      type: object
      description: A location that the rule is applicable to
      properties:
        type:
          type: string
          enum:
            - ANYWHERE
            - STATE
            - CITY
            - MARKET
          example: ANYWHERE
          description: >
            The location type. 


            For type ANYWHERE no fields are required.


            For type STATE - "country" and "state" fields are required.


            For type CITY - "country", "state" and "city" fields are required.


            For type MARKET - "country", "marketCode" and "marketName" fields are required.
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
        marketCode:
          type: string
          description: Market code
          example: NY_ALB
        marketName:
          type: string
          description: Market name
          example: Albany Market
      required:
        - type
    Pricing_LengthOfHaulRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_IntegerRange"
      description: >
        Range of the distance of the route to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: integer
          description: Minimum distance in miles
          minimum: 0
          example: 50
        to:
          type: integer
          description: Maximum distance in miles
          minimum: 0
          example: 250
    Pricing_WeightRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_IntegerRange"
      description: >
        Weight range, of the cargo, to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: integer
          description: Minimum weight in lb
          minimum: 0
          example: 0
        to:
          type: integer
          description: Maximum weight in lb
          minimum: 0
          example: 45000
    Pricing_MatchingTimeRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_FloatRange"
      description: >
        Matching time range to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: number
          format: float
          description: Minimum matching time in hours
          minimum: 0
          example: 20
        to:
          type: number
          format: float
          description: Maximum matching time in hours
          minimum: 0
          example: 30
    Pricing_TransitTimeRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_FloatRange"
      description: >
        Transit time range to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: number
          format: float
          description: Minimum transit time in hours
          minimum: 0
          example: 10
        to:
          type: number
          format: float
          description: Maximum transit time in hours
          minimum: 0
          example: 24
    Pricing_RuleConditions:
      type: object
      description: |
        Conditions in which this rule is applicable.

        When multuple conditions are provided the rule is only applied 
        if all of them are met
      properties:
        commodity:
          type: array
          description: >
            List of commodities to which the rule is applicable.

            At least one commodity from this list has to match for the rule to apply
          items:
            type: string
          example:
            - Apples
        confidenceLevel:
          $ref: "#/components/schemas/Pricing_ConfidenceLevelRange"
        customers:
          type: array
          description: >
            List of customers to which the rule is applicable. 

            At least one customer from this list has to match for the rule to apply
          items:
            type: string
            description: Customer name
          example:
            - LTR and Co
            - CocaCola
            - Walmart
        lanes:
          type: array
          description: |
            List of lanes to which the rule is applicable. 
            At least one lane from this list has to match for the rule to apply
          items:
            $ref: "#/components/schemas/Pricing_RuleLane"
        lengthOfHaul:
          $ref: "#/components/schemas/Pricing_LengthOfHaulRange"
        matchingTime:
          $ref: "#/components/schemas/Pricing_MatchingTimeRange"
        transitTime:
          $ref: "#/components/schemas/Pricing_TransitTimeRange"
        transportTypes:
          type: array
          maxItems: 2
          description: >
            List of transport types to which the rule is applicable.

            At least one transport type from this list has to match for the rule to apply
          items:
            $ref: "#/components/schemas/Pricing_TransportType"
        users:
          type: array
          description: |
            List of users to whom the rule is applicable. 
            At least one user from this list has to match for the rule to apply
          items:
            type: string
        weight:
          $ref: "#/components/schemas/Pricing_WeightRange"
        stopsCount:
          $ref: "#/components/schemas/Pricing_StopsCountRange"
        mileageDifference:
          $ref: "#/components/schemas/Pricing_MileageDifferenceRange"
    Pricing_CombinationRule:
      type: object
      description: Combination pricing rule
      properties:
        id:
          type: integer
          format: int64
          description: Id of the rule
          example: 12345
        name:
          type: string
          description: Name of the pricing rule
          example: Customer`s rule
        active:
          type: boolean
          description: Status of the rule
          example: false
        conditions:
          $ref: "#/components/schemas/Pricing_RuleConditions"
        effects:
          $ref: "#/components/schemas/Pricing_CombinationRuleEffects"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
      required:
        - id
        - name
        - active
        - conditions
        - effects
    Pricing_PriorityRule:
      type: object
      description: Priority pricing rule
      properties:
        id:
          type: integer
          format: int64
          description: Id of the rule
          example: 12345
        name:
          type: string
          description: Name of the rule
          example: Customer`s rule
        priority:
          type: integer
          description: Priority of the rule
          example: 3
        active:
          type: boolean
          description: Status of the rule
          example: false
        conditions:
          $ref: "#/components/schemas/Pricing_RuleConditions"
        effects:
          $ref: "#/components/schemas/Pricing_PriorityRuleEffects"
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
      required:
        - id
        - name
        - priority
        - active
        - conditions
        - effects
    Pricing_PricingRatePerMileAndMileage:
      type: object
      description: |
        Composite object representing rate per miles and mileage
      properties:
        rate:
          type: number
          description: >
            The per mile buy rate that the calculated pricing effect will be
            applied to, 

            in order to calculate the target sell rate
          example: 3.4
        miles:
          type: number
          description: |
            Estimated miles for the trip
          example: 667
      required:
        - rate
        - miles
    Pricing_PricingRulesSearchRequest:
      type: object
      properties:
        filters:
          $ref: "#/components/schemas/Pricing_PricingRuleFilters"
    Pricing_PricingPriorityRulesSearchRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_PricingRulesSearchRequest"
      properties:
        sorting:
          $ref: "#/components/schemas/Pricing_PricingPriorityRulesSorting"
    Pricing_PricingCombinationRulesSearchRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_PricingRulesSearchRequest"
      properties:
        sorting:
          $ref: "#/components/schemas/Pricing_PricingCombinationRulesSorting"
    Pricing_PricingCombinationRulesSearchResponse:
      type: object
      description: Combination pricing rules search response
      properties:
        pagination:
          $ref: "#/components/schemas/Pricing_Pagination"
        items:
          type: array
          description: List of combination rules
          items:
            $ref: "#/components/schemas/Pricing_CombinationRule"
      required:
        - pagination
        - items
    Pricing_PricingPriorityRulesSearchResponse:
      type: object
      description: Priority pricing rules search response
      properties:
        pagination:
          $ref: "#/components/schemas/Pricing_Pagination"
        items:
          type: array
          description: List of rules
          items:
            $ref: "#/components/schemas/Pricing_PriorityRule"
      required:
        - pagination
        - items
    Pricing_PricingCheckRuleNameExistsResponse:
      type: object
      properties:
        value:
          type: boolean
          example: false
          description: |
            True if rule name already exists
      required:
        - value
    Pricing_PricingRuleFilters:
      type: object
      description: Rule filters
      properties:
        creationDateRange:
          type: object
          description: Date range to search for the report data
          properties:
            from:
              type: string
              format: date
              description: |
                Date to start the search from. 
                Format is ISO date. 
                Time zone is considered to be UTC.

                Defaults to a month ago from now.
              example: "2023-06-18"
            to:
              type: string
              format: date
              description: |
                Date to end the search at. 
                Format is ISO date. 
                Time zone is considered to be UTC.

                Defaults to today.
              example: "2023-10-18"
        transportTypeGroups:
          type: array
          description: Transport type groups to look for in the rule conditions
          items:
            type: string
            description: Transport type group
            enum:
              - VAN
              - REEFER
              - FLATBED
              - HOTSHOT
              - OTHER
            example: VAN
        origins:
          type: array
          description: >
            Origin locations.


            The most granular provided value is used for filtering. 

            e.g if the most granular value is:

            * zip - data will be filtered by zip code

            * city - data will be filtered by city (in this case state is required)

            * state - data will be filtered by state
          items:
            $ref: "#/components/schemas/Pricing_LocationFilter"
        destinations:
          type: array
          description: >
            Destination locations.


            The most granular provided value is used for filtering. 

            e.g if the most granular value is:

            * zip - data will be filtered by zip code

            * city - data will be filtered by city (in this case state is required)

            * state - data will be filtered by state
          items:
            $ref: "#/components/schemas/Pricing_LocationFilter"
        shippers:
          type: array
          description: Shipper company names to look for in the rule conditions
          items:
            type: string
            description: Shipper company name
            example: Walmart
        commodities:
          type: array
          description: list of commodities to look for in the rule conditions
          items:
            type: string
            description: Commodity description in free form
            example: Steel racks
        users:
          type: array
          description: Users to look for in the rule conditions
          items:
            type: string
            description: User
            example: user@greenscreens.ai
        distanceRanges:
          type: array
          description: Distance ranges to look for in the rule conditions
          items:
            $ref: "#/components/schemas/Pricing_DistanceRange"
        confidenceLevelRanges:
          type: array
          description: Confidence level ranges to look for in the rule conditions
          items:
            $ref: "#/components/schemas/Pricing_ConfidenceRangeFilter"
        ruleName:
          type: string
          description: Name part of pricing rule
          example: Extra long rule name 2
        transitTimeRanges:
          type: array
          description: Transit time ranges to look for in the rule conditions
          items:
            $ref: "#/components/schemas/Pricing_TransitTimeRangeFilter"
        matchingTimeRanges:
          type: array
          description: Matching time ranges to look for in the rule conditions
          items:
            $ref: "#/components/schemas/Pricing_MatchingTimeRangeFilter"
        weightRanges:
          type: array
          description: Weight ranges to look for in the rule conditions
          items:
            $ref: "#/components/schemas/Pricing_WeightRangeFilter"
        active:
          type: boolean
          description: Status of the rule
          example: false
        pricingTypeGroup:
          $ref: "#/components/schemas/Pricing_PricingRuleGroup"
    Pricing_PricingPriorityRulesSorting:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_PricingRulesSorting"
      description: |
        Sorting settings for the rule analytics table response
      properties:
        sortBy:
          type: string
          enum:
            - CREATION_DATE
            - RULE_NAME
            - STATUS
            - PRIORITY
          description: |
            The field that the response data should be sorted by
          default: STATUS
          example: CREATION_DATE
    Pricing_PricingCombinationRulesSorting:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_PricingRulesSorting"
      description: |
        Sorting settings for the rule analytics table response
      properties:
        sortBy:
          type: string
          enum:
            - CREATION_DATE
            - RULE_NAME
            - STATUS
          description: |
            The field that the response data should be sorted by
          default: STATUS
          example: CREATION_DATE
    Pricing_PricingRulesSorting:
      type: object
      description: |
        Sorting settings for the rule analytics table response
      properties:
        sortOrder:
          type: string
          enum:
            - ASCENDING
            - DESCENDING
          description: |
            Order in which the response data should be sorted
          default: DESCENDING
          example: ASCENDING
    Pricing_PricingRuleFilterValuesResponse:
      type: object
      properties:
        shippers:
          type: array
          description: |
            Shipper names present in the pricing rules
          items:
            type: string
            description: Shipper name
            example: Walmart
        users:
          type: array
          description: |
            User names present in the pricing rules
          items:
            type: string
            description: User name or code or email, etc.
            example: leroy.jenkins@greenscreens.ai
      required:
        - shippers
        - users
    Pricing_LocationFilter:
      type: object
      description: |
        Location descriptor used for filtering reports.

        The most granular provided value is used for filtering. 
        e.g if the most granular value is:
        * city - data will be filtered by city (in this case state is required)
        * state - data will be filtered by state
        * marketCode - data will be filtered by market code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        marketCode:
          type: string
          description: Market code
          example: NY_ALB
        state:
          type: string
          description: State
          example: NY
        city:
          type: string
          description: City
          example: Schenectady
      required:
        - country
    Pricing_DistanceRange:
      type: object
      description: Distance range (inclusive)
      properties:
        from:
          type: integer
          description: Start distance (inclusive)
          minimum: 0
          example: 1000
        to:
          type: integer
          description: End distance (inclusive)
          minimum: 0
          example: 1500
    Pricing_ConfidenceRangeFilter:
      type: object
      description: Confidence range to search for the report data
      properties:
        from:
          type: integer
          description: Confidence level to start the search from
          minimum: 0
          example: 76
          default: 0
        to:
          type: integer
          description: Confidence level to end the search at
          minimum: 0
          example: 87
          default: 100
    Pricing_TransitTimeRangeFilter:
      type: object
      description: |
        Transit time range filter
      properties:
        from:
          type: number
          format: float
          description: Minimum transit time in hours
          minimum: 0
          example: 10
        to:
          type: number
          format: float
          description: Maximum transit time in hours
          minimum: 0
          example: 24
    Pricing_WeightRangeFilter:
      type: object
      description: |
        Weight range filter
      properties:
        from:
          type: integer
          description: Minimum weight in lb
          minimum: 0
          example: 0
        to:
          type: integer
          description: Maximum weight in lb
          minimum: 0
          example: 45000
    Pricing_MatchingTimeRangeFilter:
      type: object
      description: |
        Matching time range filter
      properties:
        from:
          type: number
          format: float
          description: Minimum matching time in hours
          minimum: 0
          example: 20
        to:
          type: number
          format: float
          description: Maximum matching time in hours
          minimum: 0
          example: 30
    Pricing_Pagination:
      type: object
      description: Response pagination data
      properties:
        pageNumber:
          type: integer
          description: Current page number (zero-based)
          minimum: 0
          example: 0
        pageSize:
          type: integer
          description: Number of items per page
          minimum: 1
          example: 50
        totalElements:
          type: integer
          format: int64
          description: Total number of items available
          example: 150
        totalPages:
          type: integer
          description: Total number of pages
          example: 3
      required:
        - pageNumber
        - pageSize
    Pricing_IntegerRange:
      type: object
      properties:
        from:
          type: integer
          minimum: 0
          example: 50
        to:
          type: integer
          minimum: 0
          example: 250
    Pricing_FloatRange:
      type: object
      properties:
        from:
          type: number
          format: float
          minimum: 0
          example: 20
        to:
          type: number
          format: float
          minimum: 0
          example: 30
    Pricing_StopsCountRange:
      type: object
      description: >
        Range of the stops count of the route to which the rule is applicable.


        Stops count includes origin and destination i.e. route with one extra stop will have 3 stops in total.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either 

        `<= 'to'` or `>= 'from'`
      allOf:
        - $ref: "#/components/schemas/Pricing_IntegerRange"
      properties:
        from:
          type: integer
          minimum: 0
          description: Minimum stops count
          example: 3
        to:
          type: integer
          minimum: 0
          description: Maximum stops count
          example: 10
    Pricing_MileageDifferenceRange:
      type: object
      allOf:
        - $ref: "#/components/schemas/Pricing_IntegerRange"
      description: >
        Range of the stops count of the route to which the rule is applicable.


        At least one of the range boundaries has to be provided.


        If only one range boundary is provided, it means that the range is either

        `<= 'to'` or `>= 'from'`
      properties:
        from:
          type: integer
          description: Minimum difference in miles
          minimum: 0
          example: 50
        to:
          type: integer
          description: Maximum difference in miles
          minimum: 0
          example: 250
    Quotes_QuotesResponse:
      type: object
      description: Object containing an array of quotes
      properties:
        pagination:
          type: object
          description: Response pagination data
          properties:
            page:
              type: integer
              description: The number of the currently returned page
              minimum: 0
              example: 12
            perPage:
              type: integer
              description: The maximum number of items per page
              minimum: 1
              maximum: 500
              example: 20
          required:
            - page
            - perPage
        items:
          type: array
          description: Array of quotes
          items:
            $ref: "#/components/schemas/Quotes_QuoteObject"
      required:
        - pagination
        - items
    Quotes_QuotePatchRequest:
      type: object
      properties:
        status:
          $ref: "#/components/schemas/Quotes_QuoteStatus"
        wasViewed:
          type: boolean
          description: |
            States whether the quote was viewed by a broker after being 
            accepted or rejected by a customer.
          example: false
        rejectionReason:
          type: string
          description: Comment about why the quote was rejected
          example: Customer rejected, because price was too high
        expirationDateTime:
          type: string
          format: date-time
          description: Quote expiration date and time in time zone of the user
          example: "2020-10-12T16:00:00+05:00"
    Quotes_QuoteFullUpdateRequest:
      type: object
      properties:
        shipper:
          $ref: "#/components/schemas/Quotes_Shipper"
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the quote
          example: buddy@greenscreens.ai
        transportTypeGroup:
          type: string
          enum:
            - VAN
            - REEFER
            - FLATBED
            - HOTSHOT
          description: Transport type group
          example: VAN
        stops:
          $ref: "#/components/schemas/Quotes_StopsInput"
        distance:
          type: number
          format: float
          description: Distance of the route (in miles)
          example: 289
        expirationDateTime:
          type: string
          format: date-time
          description: Quote expiration date and time in time zone of the user
          example: "2020-10-12T16:00:00+05:00"
        pickupDateTime:
          type: string
          format: date-time
          description: Related load pickup date
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Related load delivery date
          example: "2020-10-14T16:00:00Z"
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        costs:
          $ref: "#/components/schemas/Quotes_CostsInput"
        currency:
          $ref: "#/components/schemas/Quotes_Currency"
      required:
        - userEmail
        - transportTypeGroup
        - stops
        - pickupDateTime
        - shipper
        - costs
    Quotes_QuoteObject:
      type: object
      description: Object representing a quote in our system
      properties:
        id:
          type: integer
          format: int64
          description: Id of the quote. Specific to our system and unique for every quote.
          example: 12345
        key:
          type: string
          description: Unique key used to create a link to the quote in the platform
          example: afd124faf-12raf-qfa2q-afvawf
        quoteId:
          type: string
          description: Unique quote id from the customers system
          example: Q#54321
        loadId:
          type: string
          description: Id of the load associated with this quote
          example: "12345"
        userEmail:
          type: string
          description: Email of the user who is the owner/creator of the quote
          example: buddy@greenscreens.ai
        transportType:
          type: string
          description: Transport type (original transport type used in provider TMS)
          example: VR
        transportTypeGroup:
          $ref: "#/components/schemas/Quotes_TransportTypeGroup"
        stops:
          $ref: "#/components/schemas/Quotes_Stops"
        distance:
          type: number
          format: float
          description: Distance of the route (in miles)
          example: 289
        pickupDateTime:
          type: string
          format: date-time
          description: Related load pickup date
          example: "2020-09-14T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Related load delivery date
          example: "2020-09-14T16:00:00Z"
        expirationDateTime:
          type: string
          format: date-time
          description: Expiration date and time in UTC time zone
          example: "2020-09-14T16:00:00Z"
        quoteDateTime:
          type: string
          format: date-time
          description: When the quote was sent to the customer
          example: "2020-10-13T16:00:00Z"
        defaultedQuoteDateTime:
          type: string
          format: date-time
          description: |
            Same as `quoteDateTime` but defaulted to `createdDateTime`, 
            if `quoteDateTime` is not available 
          example: "2020-09-14T16:00:00Z"
        createdDateTime:
          type: string
          format: date-time
          description: Quote creation date
          example: "2020-09-14T16:00:00Z"
        status:
          $ref: "#/components/schemas/Quotes_QuoteStatus"
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        predictions:
          $ref: "#/components/schemas/Quotes_Predictions"
        wasViewed:
          type: boolean
          description: |
            Signifies whether the quote was viewed by a broker after being 
            accepted or rejected by a customer.
          example: false
        rejectionReason:
          type: string
          description: Comment about why the quote was rejected
          example: Rejecting, because price is too high
        shipper:
          $ref: "#/components/schemas/Quotes_Shipper"
        pricingType:
          type: string
          description: >
            How this shipment was priced to the shipper according to your
            methodology 

            (Primary, Backup, Spot, Spot_api, Spot_EDI, Primary_cost_plus, etc.)
          example: SPOT
        pricingTypeGroup:
          $ref: "#/components/schemas/Quotes_PricingTypeGroup"
        contractDuration:
          type: integer
          description: Contract duration in weeks, if applicable
          example: 5
        numberOfLoads:
          type: integer
          description: |
            Number of loads on the lane quoted or won:
            * for the day if a spot quote
            * for the duration of the contract if a primary or backup quote
          example: 10
        costs:
          $ref: "#/components/schemas/Quotes_Costs"
        currency:
          type: string
          description: >
            Currency of any monetary fields in this object (Three letter code,
            ISO 4217)
          example: USD
        notes:
          type: string
          description: |
            Optional free-text notes associated with this quote
          example: Do not dispatch before Monday
      required:
        - id
        - key
        - userEmail
        - transportTypeGroup
        - stops
        - pickupDateTime
        - defaultedQuoteDateTime
        - createdDateTime
        - status
        - wasViewed
        - costs
        - currency
    Quotes_Costs:
      type: object
      description: >
        Quote costs. 


        **Linehaul cost and either total cost or acessorials have to be provided 

        for this object to be valid.**
      properties:
        linehaul:
          type: number
          description: Flat linehaul cost that the customer was quoted
          example: 1200
        accessorials:
          $ref: "#/components/schemas/Quotes_Accessorials"
        total:
          type: number
          description: |
            Flat total cost that the customer was quoted 
            (linehaul + accessorials)
          example: 1500
      required:
        - linehaul
        - accessorials
        - total
    Quotes_CostsInput:
      type: object
      description: >
        Quote costs. 


        **Linehaul cost and either total cost or acessorials have to be provided 

        for this object to be valid.**
      properties:
        linehaul:
          type: number
          description: Flat linehaul cost that the customer was quoted
          example: 1200
        accessorials:
          $ref: "#/components/schemas/Quotes_AccessorialsInput"
        total:
          type: number
          description: |
            Flat total cost that the customer was quoted 
            (linehaul + accessorials)
          example: 1500
      required:
        - linehaul
    Quotes_Accessorials:
      type: array
      description: Quote accessorial list
      items:
        $ref: "#/components/schemas/Quotes_Accessorial"
    Quotes_Accessorial:
      type: object
      description: Contains the quote accessorial information e.g. name and cost
      properties:
        name:
          type: string
          description: Accessorial name
          example: Overweight
        cost:
          type: number
          description: Flat accessorial cost
          example: 200.5
      required:
        - name
        - cost
    Quotes_AccessorialsInput:
      type: array
      description: Quote accessorial list
      items:
        $ref: "#/components/schemas/Quotes_AccessorialInput"
    Quotes_AccessorialInput:
      type: object
      description: Contains the quote accessorial information e.g. name and cost
      nullable: true
      properties:
        name:
          type: string
          description: Accessorial name
          example: Overweight
        cost:
          type: number
          description: Flat accessorial cost
          example: 200.5
      required:
        - name
        - cost
    Quotes_Stops:
      type: array
      description: Quote stop list
      minItems: 2
      items:
        $ref: "#/components/schemas/Quotes_Stop"
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
            type: CITY
          type: LOAD
          appointmentDateTime: "2020-10-13T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
            type: ZIP
          type: UNLOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
    Quotes_StopsInput:
      type: array
      description: Quote stop list
      minItems: 2
      items:
        $ref: "#/components/schemas/Quotes_StopInput"
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
          type: LOAD
          appointmentDateTime: "2020-10-13T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
          type: UNLOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
    Quotes_StopsInputLaneTopQuotes:
      type: array
      description: Quote stop list
      minItems: 2
      items:
        $ref: "#/components/schemas/Quotes_StopInputLaneTopQuotes"
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
    Quotes_Stop:
      type: object
      description: Contains the quote stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/Quotes_Address"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    Quotes_StopInput:
      type: object
      description: Contains the quote stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/Quotes_AddressInput"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop.

            Leave this field empty if you do not know the stop type.
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T16:00:00Z"
      required:
        - order
        - address
    Quotes_StopInputLaneTopQuotes:
      type: object
      description: Contains the quote stop information e.g. address
      properties:
        order:
          type: integer
          description: Stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/Quotes_AddressInputLaneTopQuotes"
      required:
        - order
        - address
    Quotes_Address:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
        type:
          type: string
          enum:
            - CITY
            - ZIP
          example: ZIP
          description: Type of address. Defaults to ZIP if not provided.
          default: ZIP
      required:
        - country
        - type
    Quotes_AddressInput:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - country
    Quotes_AddressInputLaneTopQuotes:
      type: object
      description: |
        Location specified by country, city, state and zip code
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        state:
          type: string
          description: state
          example: NY
        city:
          type: string
          description: city
          example: Schenectady
        zip:
          type: string
          description: zip
          example: "12345"
      required:
        - country
        - state
        - city
        - zip
    Quotes_Shipper:
      type: object
      description: Shipper data
      properties:
        id:
          type: string
          description: Customer TMS ID of the shipper profile associated with this quote
          example: "64378901"
        name:
          type: string
          description: Shipper company name
          example: Walmart
        phone:
          type: string
          description: Shipper contact phone number
          example: "4112228888"
        email:
          type: string
          description: Shipper contact email
          example: test@greenscreens.ai
    Quotes_Predictions:
      type: object
      description: |
        Predictions made for this quote.

        The fields in this object are populated asynchronously,
        so there might be a period in time when you will not see any values.
      properties:
        company:
          type: object
          description: Company specific predictions
          properties:
            buy:
              type: object
              description: Buy cost related properties
              properties:
                target:
                  type: number
                  description: Flat buy cost that our system would suggest to use for buying such
                    a load
                  example: 1200
                start:
                  type: number
                  description: Flat buy cost that our system would suggest to use as the lower
                    limit during bargaining with the carrier
                  example: 1200
                high:
                  type: number
                  description: Flat buy cost that our system would suggest to use as the upper
                    limit during bargaining with the carrier
                  example: 1200
                confidenceLevel:
                  type: integer
                  minimum: 0
                  maximum: 100
                  description: |
                    How confident the system is in the prediction it is making. 

                    From 0 - lowest possible confidence\
                    To 100 - highest possible confidence
                  example: 65
            sell:
              type: object
              description: Sell cost related properties
              properties:
                target:
                  type: number
                  description: Flat sell cost that our system would suggest to use for this quote
                  example: 1200
        network:
          type: object
          description: Network predictions
          properties:
            buy:
              type: object
              description: Buy cost related properties
              properties:
                target:
                  type: number
                  description: Flat buy cost that our system would suggest to use for buying such
                    a load
                  example: 1200
                confidenceLevel:
                  type: integer
                  minimum: 0
                  maximum: 100
                  description: |
                    How confident the system is in the prediction it is making. 

                    From 0 - lowest possible confidence\
                    To 100 - highest possible confidence
                  example: 65
        distance:
          type: number
          format: float
          description: Distance of the route (in miles)
          example: 289
    Quotes_QuotesImportRequest:
      type: object
      description: A body of the request to import a quote
      properties:
        quoteId:
          type: string
          description: |
            Unique quote id from the customers system. 

            If a quote with the same quoteId will be found in our platform, 
            it will be updated. Otherwise a new quote will be created
          example: Q#54321
        loadId:
          type: string
          description: Id of the load associated with this quote
          example: "12345"
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the quote
          example: buddy@greenscreens.ai
        transportType:
          type: string
          description: Transport type (original transport type used in provider TMS)
          example: VR
        transportTypeGroup:
          $ref: "#/components/schemas/Quotes_TransportTypeGroup"
        stops:
          $ref: "#/components/schemas/Quotes_StopsInput"
        distance:
          type: number
          format: float
          description: Distance of the route (in miles)
          example: 289
        pickupDateTime:
          type: string
          format: date-time
          description: Related load pickup date
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Related load delivery date
          example: "2020-10-14T16:00:00Z"
        expirationDateTime:
          type: string
          format: date-time
          description: Quote expiration date and time in time zone of the user
          example: "2020-10-12T16:00:00+05:00"
        quoteDateTime:
          type: string
          format: date-time
          description: When the quote was sent to the customer
          example: "2020-10-13T16:00:00Z"
        status:
          $ref: "#/components/schemas/Quotes_QuoteStatus"
        rejectionReason:
          type: string
          description: Comment about why the quote was rejected
          example: Rejecting, because price is too high
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        shipper:
          $ref: "#/components/schemas/Quotes_Shipper"
        pricingType:
          type: string
          description: >
            How this shipment was priced to the shipper according to your
            methodology 

            (Primary, Backup, Spot, Spot_api, Spot_EDI, Primary_cost_plus, etc.)
          example: SPOT
        pricingTypeGroup:
          $ref: "#/components/schemas/Quotes_PricingTypeGroup"
        contractDuration:
          type: integer
          description: Contract duration in weeks, if applicable
          example: 5
        numberOfLoads:
          type: integer
          description: |
            Number of loads on the lane quoted or won:
            * for the day if a spot quote
            * for the duration of the contract if a primary or backup quote
          example: 10
        costs:
          $ref: "#/components/schemas/Quotes_CostsInput"
        currency:
          $ref: "#/components/schemas/Quotes_Currency"
      required:
        - quoteId
        - userEmail
        - transportType
        - transportTypeGroup
        - stops
        - pickupDateTime
        - status
        - shipper
        - pricingType
        - pricingTypeGroup
        - costs
        - currency
    Quotes_QuotesImportResponse:
      type: object
      description: Quote import response
      properties:
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
          description: |
            Quote creation status. 
            * CREATED - a new quote was created
            * UPDATED - an existing quote was updated
          example: CREATED
      required:
        - status
    Quotes_QuotesBatchImportRequest:
      type: object
      properties:
        quotes:
          type: array
          description: List of quotes to import
          items:
            $ref: "#/components/schemas/Quotes_QuotesImportRequest"
          maxItems: 1000
      required:
        - quotes
    Quotes_QuotesBatchImportResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of quote import responses
          items:
            $ref: "#/components/schemas/Quotes_QuotesBatchImportResponseItem"
      required:
        - responses
    Quotes_QuotesBatchImportResponseItem:
      type: object
      description: |
        Response for this particular quote import attempt
      properties:
        quoteId:
          type: string
          description: Unique quote id from the customers system
          example: Q#54321
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
            - ERROR
          description: |
            Quote import status. 
            * CREATED - a new quote was created
            * UPDATED - an existing quote was updated
            * ERROR - an error occurred during quote import
          example: CREATED
        error:
          type: object
          description: |
            Import attempt error data. 
            Available when the import attempt was unsuccessful 
            and status is ERROR
          properties:
            code:
              type: string
              description: Unique string identifier of the error
              example: validation_errors_occured
            message:
              type: string
              description: Human readable error message
              example: Validation errors occured, check errors array for details
            errors:
              type: array
              description: A list of validation errors that occurred during the import
                attempt.
              items:
                $ref: "#/components/schemas/Quotes_RequestValidationError"
          required:
            - code
            - message
            - errors
      required:
        - quoteId
        - status
    Quotes_QuotesOtherCompanyBatchImportRequest:
      type: object
      properties:
        companyId:
          type: string
          description: |
            Id of the company that you want the quotes to be imported for
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
        quotes:
          type: array
          description: List of quotes to import
          items:
            $ref: "#/components/schemas/Quotes_QuotesImportRequest"
          maxItems: 1000
      required:
        - companyId
        - quotes
    Quotes_QuotesSendRequest:
      type: object
      properties:
        userEmail:
          type: string
          description: Email of the user who will be the owner/creator of the quote
          example: buddy@greenscreens.ai
        transportTypeGroup:
          type: string
          enum:
            - VAN
            - REEFER
            - FLATBED
            - HOTSHOT
          description: Transport type group
          example: VAN
        stops:
          $ref: "#/components/schemas/Quotes_StopsInput"
        distance:
          type: number
          format: float
          description: Distance of the route (in miles)
          example: 289
        pickupDateTime:
          type: string
          format: date-time
          description: Related load pickup date
          example: "2020-10-13T16:00:00Z"
        deliveredDateTime:
          type: string
          format: date-time
          description: Related load delivery date
          example: "2020-10-14T16:00:00Z"
        expirationDateTime:
          type: string
          format: date-time
          description: Quote expiration date and time in time zone of the user
          example: "2020-10-12T16:00:00+05:00"
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        shipper:
          $ref: "#/components/schemas/Quotes_Shipper"
        costs:
          $ref: "#/components/schemas/Quotes_CostsInput"
        currency:
          $ref: "#/components/schemas/Quotes_Currency"
        notes:
          type: string
          description: Optional free-text notes associated with this quote
          example: Do not dispatch before Monday
      required:
        - userEmail
        - transportTypeGroup
        - stops
        - pickupDateTime
        - expirationDateTime
        - shipper
        - costs
    Quotes_QuotesSendResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Id of the quote. Specific to our system and unique for every quote.
          example: 12345
        key:
          type: string
          description: Unique key used to create a link to the quote in the platform
          example: afd124faf-12raf-qfa2q-afvawf
      required:
        - id
        - key
    Quotes_QuotesLaneTopQuotesRequest:
      type: object
      properties:
        transportTypeGroup:
          type: string
          enum:
            - VAN
            - REEFER
            - FLATBED
            - HOTSHOT
          description: Transport type group
          example: VAN
        stops:
          $ref: "#/components/schemas/Quotes_StopsInputLaneTopQuotes"
        pickupDateTimeFrom:
          type: string
          format: date-time
          description: |
            \'quote pickup date <= value\' filter.

            At least one date filter needs to be provided
          example: "2020-01-11T16:00:00Z"
        defaultedQuoteDateTimeFrom:
          type: string
          format: date-time
          description: |
            \'defaulted quote date <= value\' filter

            At least one date filter needs to be provided
          example: "2020-01-11T16:00:00Z"
        region:
          $ref: "#/components/schemas/Quotes_GeographicalArea"
        currency:
          $ref: "#/components/schemas/Quotes_Currency"
      required:
        - transportTypeGroup
        - stops
        - region
    Quotes_QuotesLaneTopQuotesResponse:
      type: object
      description: Contains an array of ten most recent quotes for a lane
      properties:
        items:
          type: array
          description: Top (latest) quotes for this lane
          items:
            $ref: "#/components/schemas/Quotes_QuoteObject"
      required:
        - items
    Quotes_QuotesShippersResponse:
      type: object
      description: Contains a list of shippers
      properties:
        items:
          type: array
          description: List of shippers
          items:
            $ref: "#/components/schemas/Quotes_QuotesShippersResponseItem"
      required:
        - items
    Quotes_QuotesShippersResponseItem:
      type: object
      description: Shipper profile information
      properties:
        id:
          type: string
          description: Customer TMS ID of the shipper profile associated with this quote
          example: "64378901"
        name:
          type: string
          description: Shipper company name
          example: Joes Foods
        phone:
          type: string
          description: Shipper contact phone number
          example: "4112228888"
        email:
          type: string
          description: Shipper contact email
          example: test@greenscreens.ai
      required:
        - id
        - name
    Quotes_QuotesAcceptRequest:
      type: object
      properties:
        key:
          type: string
          description: |
            Unique key of the quote that you want accepted. 
            Provided during quote creation.
          example: afd124faf-12raf-qfa2q-afvawf
      required:
        - key
    Quotes_QuotesRejectRequest:
      type: object
      properties:
        key:
          type: string
          description: |
            Unique key of the quote that you want rejected. 
            Provided during quote creation.
          example: afd124faf-12raf-qfa2q-afvawf
        rejectionReason:
          type: string
          description: |
            Customer comment about why he rejected the quote.
          example: Rejecting because the cost is too high for me, sorry.
      required:
        - key
    Quotes_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    Quotes_Error422UnprocessableEntityMulti:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        errors:
          type: array
          description: list of errors
          items:
            $ref: "#/components/schemas/Quotes_RequestValidationError"
      required:
        - code
        - message
        - errors
      example:
        code: request_validation
        message: You have one or more errors in request structure
        errors:
          - field: carrierName
            message: field contains wrong data type (int), should be string
            value: "22"
          - field: shipperId
            message: "shipperId: must not be null"
            value: null
          - field: loadSource.loadId
            message: "loadId: must not be null"
            value: null
    Quotes_RequestValidationError:
      type: object
      description: Request validation error
      properties:
        field:
          type: string
          description: Name of the field that did not pass validation
          example: transportType
        message:
          type: string
          description: Human readable error mesage explaining why validation failed
          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
            FLATBED, ...]
        value:
          type: string
          nullable: true
          description: Value of the field that did not pass validation
          example: SpaceXDragon
      required:
        - field
        - message
    Quotes_Currency:
      type: string
      enum:
        - USD
        - CAD
      description: |
        Currency code in ISO 4217 format (three letter code, e.g. USD)

        _If not provided, defaults to the currency set in the profile 
        of currently authenticated user (or currently authenticated company 
        if there is no user or user profile setting)_
      example: USD
    Quotes_GeographicalArea:
      type: string
      enum:
        - CITY
        - CITY_ZIP
        - ZIP_CITY
        - ZIP
        - 3DZIP
        - KMA
      description: >
        Determines the size of the area around the origin and destination
        points, 

        that will be searched for the related data.

        * CITY - narrow, city wide, area

        * ZIP - narrow, five digit zip, area

        * 3DZIP - medium, short zip, area

        * KMA - big, market wide, area

        * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

        * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
      example: ZIP
    Quotes_PricingTypeGroup:
      type: string
      description: |
        How this shipment was priced to the shipper in the following groupings
        (CONTRACT, SPOT, or OTHER)
      enum:
        - CONTRACT
        - SPOT
        - OTHER
      example: SPOT
    Quotes_QuoteStatus:
      type: string
      description: Quote lifecycle stage
      enum:
        - WON
        - LOST
        - SENT
        - EXPIRED
      example: WON
    Quotes_TransportTypeGroup:
      type: string
      description: Transport type group
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
        - OTHER
      example: VAN
    TmsConnector_ImportLoadRequest:
      type: object
      properties:
        loadId:
          type: string
          description: >
            Unique load id from external TMS. 


            If a load with same loadId will be found in our platform during import, 

            it will be updated. Otherwise a new load will be created.
          example: "12345"
        origin:
          $ref: "#/components/schemas/TmsConnector_StopLocation"
        destination:
          $ref: "#/components/schemas/TmsConnector_StopLocation"
        extraStops:
          $ref: "#/components/schemas/TmsConnector_ExtraStops"
        rate:
          $ref: "#/components/schemas/TmsConnector_Rate"
        pickupDate:
          type: string
          format: date-time
          description: >
            Pick up date in ISO date format in the time zone of the pick up
            location
          example: "2021-09-21T13:00:00-04:00"
        deliveredDate:
          type: string
          format: date-time
          description: >
            Delivery date in ISO date format in the time zone of the drop off
            location
          example: "2021-09-22T18:00:00-04:00"
        transportType:
          type: string
          description: Transport type (original transport type used in provider TMS)
          example: VR
        transportTypeGroup:
          $ref: "#/components/schemas/TmsConnector_TransportTypeGroup"
        transportMode:
          type: string
          enum:
            - FTL
            - LTL
            - PARCEL
            - INTERMODAL
            - OTHER
          description: Transport mode
          default: FTL
          example: FTL
        status:
          type: string
          enum:
            - OPEN
            - COVERED
            - PICKUP
            - LOADED
            - STOP
            - DROPOFF
            - DELIVERED
            - TENDER_REJECTED
            - CLOSED
            - CANCELED
            - OTHER
          description: |
            Load status.

            * OPEN - Created
            * COVERED - Carrier assigned
            * PICKUP - On the pickup stop
            * LOADED - In transit
            * STOP - On the extra stop
            * DROPOFF - On the drop off stop
            * DELIVERED - Delivered
            * TENDER_REJECTED - Tender is rejected
            * CLOSED - All money paid. Processing over
            * CANCELED - Canceled
            * OTHER - Any other status, not mentioned in this enum
          example: OPEN
        details:
          $ref: "#/components/schemas/TmsConnector_Details"
        shipper:
          $ref: "#/components/schemas/TmsConnector_Shipper"
        carrier:
          $ref: "#/components/schemas/TmsConnector_Carrier"
      required:
        - loadId
        - origin
        - destination
        - rate
        - pickupDate
        - transportTypeGroup
        - transportType
    TmsConnector_ImportLoadResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the load used to identify it in our platform
          example: c6447366-9700-4851-854b-2bb41f03cde0
        loadId:
          type: string
          description: Id of the load provided by the client in the import request
          example: pr0-003
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
          description: >
            Result of the load import operation: 

            * CREATED - means that a new load was created 

            * UPDATED - means that a load with the same loadId was found and updated
          example: CREATED
      required:
        - id
        - loadId
        - status
    TmsConnector_ImportLoadForProviderRequest:
      type: object
      properties:
        brokerId:
          type: string
          description: >
            Id of the company that you want the load to be imported in
            to.  (this is an id you receive when registering a new company with
            us)
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
      required:
        - brokerId
      allOf:
        - $ref: "#/components/schemas/TmsConnector_ImportLoadRequest"
    TmsConnector_BatchImportLoadRequest:
      type: object
      properties:
        loads:
          type: array
          description: List of loads to import or update
          items:
            $ref: "#/components/schemas/TmsConnector_ImportLoadRequest"
      required:
        - loads
    TmsConnector_BatchImportLoadResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of load batch import results
          items:
            $ref: "#/components/schemas/TmsConnector_BatchImportLoadResponseItem"
      required:
        - responses
    TmsConnector_BatchImportLoadResponseItem:
      type: object
      description: Import result data for a particular load from the imported batch
      properties:
        id:
          type: string
          description: Load Id in the platform
          example: c6447366-9700-4851-854b-2bb41f03cde0
        loadId:
          type: string
          description: Unique internal load identifier from TMS
          example: pr0-003
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
            - ERROR
          description: |
            Load import status. 
            * CREATED - a new load was imported
            * UPDATED - an existing load was updated
            * ERROR - an error occurred during load import
          example: CREATED
        code:
          type: string
          description: When status is ERROR, contains a unique string identifier of the
            error
          example: validation_errors_occured
        message:
          type: string
          description: When status is ERROR, contains a human readable error message
          example: Validation errors occured, check errors array for details
        errors:
          type: array
          description: A list of validation errors that occurred during import.
          items:
            $ref: "#/components/schemas/TmsConnector_RequestValidationError"
      required:
        - id
        - loadId
        - status
    TmsConnector_BatchImportLoadForProviderRequest:
      type: object
      properties:
        brokerId:
          type: string
          description: >
            Id of the company that you want the load batch to be imported in
            to.  (this is an id you receive when registering a new company with
            us)
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
      required:
        - brokerId
      allOf:
        - $ref: "#/components/schemas/TmsConnector_BatchImportLoadRequest"
    TmsConnector_BatchImportCarrierRequest:
      type: object
      properties:
        carriers:
          type: array
          description: List of carriers to import or update
          items:
            $ref: "#/components/schemas/TmsConnector_CarrierProfile"
      required:
        - carriers
    TmsConnector_BatchImportShipperRequest:
      type: object
      properties:
        shippers:
          type: array
          description: List of shipper profiles to import or update
          items:
            $ref: "#/components/schemas/TmsConnector_ShipperProfile"
      required:
        - shippers
    TmsConnector_BatchImportProfileResponse:
      type: object
      properties:
        responses:
          type: array
          description: List of profile batch import results
          items:
            $ref: "#/components/schemas/TmsConnector_BatchImportProfileResponseItem"
      required:
        - responses
    TmsConnector_BatchImportProfileResponseItem:
      type: object
      description: Import result data for a particular profile from the imported batch
      properties:
        id:
          type: string
          description: Id of the profile used to identify it in our platform
          example: c6447366-9700-4851-854b-2bb41f03cde0
        profileId:
          type: string
          description: Id of the profile provided by the client in the import request
          example: pr0-003
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
            - ERROR
          description: >
            Result of the profile import operation: 

            * CREATED - means that a new profile was created 

            * UPDATED - means that a profile with the same profileId was found and updated

            * ERROR - an error occurred during profile import
          example: CREATED
        code:
          type: string
          description: When status is ERROR, contains a unique string identifier of the
            error
          example: validation_errors_occured
        message:
          type: string
          description: When status is ERROR, contains a human readable error message
          example: Validation errors occured, check errors array for details
        errors:
          type: array
          description: A list of validation errors that occurred during import.
          items:
            $ref: "#/components/schemas/TmsConnector_RequestValidationError"
      required:
        - profileId
        - status
    TmsConnector_Rate:
      type: object
      description: Load rate data
      properties:
        totalShipperLinehaulCost:
          type: number
          minimum: 0
          description: |
            Original agreed to price with the shipper. 
            Including fuel. 
            No accessorials
          example: 1176
        totalLinehaulCost:
          type: number
          minimum: 0
          description: |
            Load linehaul cost for the carrier.
            Including fuel.
            No accessorials.
          example: 956
        totalFuelCost:
          type: number
          minimum: 0
          description: Fuel surcharge for the load
          example: 45
        accessorials:
          $ref: "#/components/schemas/TmsConnector_Accessorials"
        totalShipperCost:
          type: number
          minimum: 0
          description: Total load cost for shipper including fuel and accessorials
          example: 1276
        totalCarrierCost:
          type: number
          minimum: 0
          description: Total load cost for carrier including fuel and accessorials
          example: 1130
        currency:
          type: string
          description: >
            Currency in which the costs were provided (ISO 4217). Defaults to
            USD.
          example: USD
      required:
        - totalLinehaulCost
    TmsConnector_Details:
      type: object
      description: Additional optional data about the load.
      properties:
        distance:
          type: number
          format: float
          description: |
            Distance between origin and destination. In miles.
          example: 434
        miles:
          type: number
          format: float
          description: >
            Total miles between origin and destination  (this field is
            deprecated, use 'distance' instead)
          example: 434
          deprecated: true
        commodity:
          type: string
          description: Commodity discription in free form
          example: Racks
        weight:
          type: number
          format: float
          description: Total cargo weight in lb
          example: 22000
        tenderedDate:
          type: string
          format: date-time
          description: Date when load was tendered
          example: "2020-01-11T16:00:00Z"
        bookedDate:
          type: string
          format: date-time
          description: Date when carrier was assigned to the load
          example: "2020-01-11T16:00:00Z"
        tordFlag:
          type: boolean
          description: \"Truck order not used\" flag
          example: false
        hazmat:
          type: boolean
          description: Hazmat endorsement is needed for this load
          example: false
        hotshot:
          type: boolean
          description: This signifies whether hotshot is used
          example: false
        teamDrive:
          type: boolean
          description: Signifies whether team drivers are needed for the load
          example: false
        overdimensional:
          type: boolean
          description: Signifies whether the load is overdimensional or not
          example: false
        dedicatedCarrierContract:
          type: boolean
          description: Signifies whether there was a dedicated contract with the carrier
            on the load
          example: false
        asset:
          type: boolean
          description: Signifies whether the load is an asset load
          example: false
        pricingType:
          type: string
          description: >
            How this shipment was priced to the shipper according to your
            methodology 

            (Primary, Backup, Spot, Spot_api, Spot_EDI, Primary_cost_plus, Contract, etc.)
          example: Spot
        pricingTypeGroup:
          $ref: "#/components/schemas/TmsConnector_PricingTypeGroup"
        carrierAccountManager:
          type: string
          description: |
            Carrier account manager. Aka Buy side rep or Operational rep. 

            The person that found/bought carrier services for this shipment.
          example: John Doe
        shipperAccountManager:
          type: string
          description: >
            Shipper account manager. Aka Account Manager.


            The person that "owns" the ongoing care and support of the shipper/customer

            that this shipment belongs to. 


            Sometimes this manager is also the Sales manager.
          example: John Doe
        salesManager:
          type: string
          description: >
            Sales manager. 


            The person that made the sale (found the shipper/customer and signed him).


            Can sometimes be the same person who is the Shipper account manager.
          example: John Doe
        userGroupId:
          type: string
          description: |
            A unique identifier (id) of a user group, 
            that this load belongs to. e.g. Main company or an Agency
          example: Main office
        office:
          type: string
          description: |
            Name of an office in your company that this load belongs to
          example: Main office
    TmsConnector_Carrier:
      type: object
      description: Carrier data
      properties:
        id:
          type: string
          description: Carrier ID
          example: "12345"
        name:
          type: string
          description: Carrier company name
          example: Carrier company
      required:
        - id
    TmsConnector_Shipper:
      type: object
      description: Shipper data
      properties:
        id:
          type: string
          description: Shipper ID
          example: "12345"
        name:
          type: string
          description: Shipper company name
          example: Shipper company
      required:
        - id
    TmsConnector_ExtraStops:
      type: array
      items:
        $ref: "#/components/schemas/TmsConnector_ExtraStop"
      description: >
        Any extra stops along the route between the origin and destination points
      example:
        - order: 0
          address:
            country: US
            city: Red Bluff
            state: CA
            zip: "96080"
          type: LOAD
          appointmentDateTime: "2020-10-14T16:00:00Z"
        - order: 1
          address:
            country: US
            city: Redding
            state: CA
            zip: "96002"
          type: UNLOAD
          appointmentDateTime: "2020-10-15T16:00:00Z"
    TmsConnector_ExtraStop:
      type: object
      description: Extra stop
      properties:
        order:
          type: integer
          description: Extra stop order, starting from 0
          example: 0
        address:
          $ref: "#/components/schemas/TmsConnector_ExtraStopAddress"
        type:
          type: string
          description: |
            Action performed with the cargo at this stop.

            Leave this field empty if you do not know the stop type.
          enum:
            - LOAD
            - UNLOAD
            - BOTH
          example: LOAD
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T16:00:00Z"
        scheduledAppointmentStartedAt:
          type: string
          format: date-time
          description: |
            Start of the scheduled appointment window at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T09:00:00Z"
        scheduledAppointmentEndedAt:
          type: string
          format: date-time
          description: |
            End of the scheduled appointment window at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T11:00:00Z"
        arrivedAt:
          type: string
          format: date-time
          description: |
            Actual arrival date and time at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T09:15:00Z"
        departedAt:
          type: string
          format: date-time
          description: |
            Actual departure date and time from this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T10:45:00Z"
      required:
        - order
        - address
    TmsConnector_ExtraStopAddress:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        city:
          type: string
          description: City name
          example: Sacramento
        state:
          type: string
          description: Two letter state code
          example: CA
        zip:
          type: string
          description: Zip code
          example: "95814"
      required:
        - country
    TmsConnector_StopLocation:
      type: object
      description: >
        Location specified by country, city, state and zip code.

        * Country is required

        * Either city-state pair or zip code is required

        * All four parameters can be passed together


        (in case of city-state pair our platform will determine the zip code

        and in case of a zip code, our platform will determine the city and the state)
      properties:
        country:
          type: string
          description: Two letter country code in ISO 3166-1 alpha-2 format
          example: US
        city:
          type: string
          description: City name
          example: Sacramento
        state:
          type: string
          description: Two letter state code
          example: CA
        zip:
          type: string
          description: Zip code
          example: "95814"
        appointmentDateTime:
          type: string
          format: date-time
          description: |
            Date and time when the truck has to arrive at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T09:00:00Z"
        scheduledAppointmentStartedAt:
          type: string
          format: date-time
          description: |
            Start of the scheduled appointment window at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T09:00:00Z"
        scheduledAppointmentEndedAt:
          type: string
          format: date-time
          description: |
            End of the scheduled appointment window at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T11:00:00Z"
        arrivedAt:
          type: string
          format: date-time
          description: |
            Actual arrival date and time at this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T09:15:00Z"
        departedAt:
          type: string
          format: date-time
          description: |
            Actual departure date and time from this stop.

            Provide the time zone of the stop location if possible.
          example: "2020-10-13T10:45:00Z"
      required:
        - country
    TmsConnector_CarrierProfile:
      type: object
      properties:
        profileId:
          type: string
          description: Profile id
          example: "13441524"
        companyName:
          type: string
          description: Company name
          example: Carggo
        legalName:
          type: string
          description: The official name of entity that owns a business
          example: Carggo
        mc:
          type: string
          description: Operating authority number assigned by the FMCSA to both carriers
            and brokers
          example: "122356"
        dot:
          type: string
          description: USDOT number assigned by the FMCSA to companies that operate
            commercial vehicles
          example: "87650005"
        scac:
          type: string
          description: Standard Carrier Alpha Code to identify vessel operating common
            carriers
          example: CGGK
        contact:
          $ref: "#/components/schemas/TmsConnector_ContactObject"
        status:
          $ref: "#/components/schemas/TmsConnector_ProfileStatus"
      required:
        - profileId
        - companyName
    TmsConnector_ContactObject:
      type: object
      description: Contact data
      properties:
        name:
          type: string
          description: Contact name
          example: John
        phoneNumber:
          type: string
          description: Contact phone number
          example: "121331343"
        email:
          type: string
          description: Contact email
          example: my@email.com
    TmsConnector_CarrierProfileForProvider:
      type: object
      properties:
        brokerId:
          type: string
          description: >
            Id of the company that you want the carrier to be imported in
            to.  (this is an id you receive when registering a new company with
            us)
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
      required:
        - brokerId
      allOf:
        - $ref: "#/components/schemas/TmsConnector_CarrierProfile"
    TmsConnector_ImportProfileResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the profile used to identify it in our platform
          example: c6447366-9700-4851-854b-2bb41f03cde0
        profileId:
          type: string
          description: Id of the profile provided by the client in the import request
          example: pr0-003
        status:
          type: string
          enum:
            - CREATED
            - UPDATED
          description: >
            Result of the profile import operation: 

            * CREATED - means that a new profile was created 

            * UPDATED - means that a profile with the same profileId was found and updated
          example: CREATED
      required:
        - id
        - profileId
        - status
    TmsConnector_ShipperProfile:
      type: object
      properties:
        profileId:
          type: string
          description: Profile id
          example: "13441524"
        companyName:
          type: string
          description: Company name
          example: Carggo
        legalName:
          type: string
          description: The official name of entity that owns a business
          example: Carggo
        contact:
          $ref: "#/components/schemas/TmsConnector_ContactObject"
        accountManager:
          type: string
          description: Shipper account manager on the broker side
          example: JAMES
        status:
          $ref: "#/components/schemas/TmsConnector_ProfileStatus"
        userGroupId:
          type: string
          description: |
            A unique identifier (id) of a user group, 
            that this profile belongs to. e.g. Main company or an Agency
          example: Main office
      required:
        - profileId
        - companyName
    TmsConnector_ShipperProfileForProvider:
      type: object
      properties:
        brokerId:
          type: string
          description: >
            Id of the company that you want the shipper to be imported in
            to.  (this is an id you receive when registering a new company with
            us)
          example: 6F9619FF-8B86-D011-B42D-00CF4FC964FF
      required:
        - brokerId
      allOf:
        - $ref: "#/components/schemas/TmsConnector_ShipperProfile"
    TmsConnector_Accessorials:
      type: array
      description: Accessorial list
      items:
        $ref: "#/components/schemas/TmsConnector_Accessorial"
    TmsConnector_Accessorial:
      type: object
      nullable: true
      description: Contains load accessorial information like name and costs
      properties:
        name:
          type: string
          description: Accessorial name
          example: Overweight
        shipperCost:
          type: number
          description: Shipper's flat cost for this accessorial
          example: 200
        carrierCost:
          type: number
          description: Carrier's flat cost for this accessorial
          example: 0
      required:
        - name
    TmsConnector_ProfileStatus:
      type: string
      description: |
        Signifies whether the imported profile is in Active or Inactive status
      enum:
        - ACTIVE
        - INACTIVE
      example: ACTIVE
      default: ACTIVE
    TmsConnector_Error:
      type: object
      description: A common api error object
      properties:
        code:
          type: string
          description: unique string identifier of the error
        message:
          type: string
          description: human readable error message
      required:
        - code
        - message
      example:
        code: invalid_request
        message: Your ClientId is invalid
    TmsConnector_TransportTypeGroup:
      type: string
      description: Transport type group
      enum:
        - VAN
        - REEFER
        - FLATBED
        - HOTSHOT
        - OTHER
      example: VAN
    TmsConnector_PricingTypeGroup:
      type: string
      description: |
        How this shipment was priced to the shipper in the following groupings
        (CONTRACT, SPOT, or OTHER)
      enum:
        - CONTRACT
        - SPOT
        - OTHER
      example: SPOT
    TmsConnector_ResponseMessage:
      type: object
      properties:
        commonResponse:
          type: string
          x-enum-varnames:
            - not_readable_message
            - access_forbidden
            - item_not_found
            - request_timeout
            - request_validation
            - parse_error
            - internal_error
            - access_forbidden_companyId
            - method_not_allowed
            - missing_required_parameter
          enum:
            - "Body request is not readable : %s"
            - Access is forbidden
            - Item not found
            - Request timeout after {} sec
            - You have one or more errors in request structure
            - "Text '%s' could not be parsed in field: %s"
            - Internal server error
            - companyId in JWT token is not equals importCompanyId in request
              body
            - Method not allowed
            - Missing required parameter
        serviceResponse:
          type: string
    TmsConnector_RequestValidationError:
      type: object
      description: Request validation error
      properties:
        field:
          type: string
          description: Name of the field that did not pass validation
          example: transportType
        message:
          type: string
          description: Human readable error mesage explaining why validation failed
          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
            FLATBED, ...]
        value:
          type: string
          nullable: true
          description: Value of the field that did not pass validation
          example: SpaceXDragon
      required:
        - field
        - message
    TmsConnector_Error422UnprocessableEntityMulti:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        errors:
          type: array
          description: list of errors
          items:
            $ref: "#/components/schemas/TmsConnector_RequestValidationError"
      required:
        - code
        - message
        - errors
      example:
        code: request_validation
        message: You have one or more errors in request structure
        errors:
          - field: carrierName
            message: field contains wrong data type (int), should be string
            value: "22"
          - field: shipperId
            message: "shipperId: must not be null"
            value: null
          - field: loadSource.loadId
            message: "loadId: must not be null"
            value: null
  parameters:
    Prediction_UserHeader:
      in: header
      name: X-GS-User
      schema:
        type: string
      description: |
        Currently logged in user. Used in cases where this information is 
        not available in the token e.g. web-portable, api integration, etc.
      example: kalex@greenscreens.ai