{
  "openapi": "3.0.1",
  "info": {
    "license": {
      "name": "© 2024 project44 - Terms of Use",
      "url": "https://www.project44.com/terms"
    },
    "description": "Version 4.0.0 of project44's API. If you're not familiar with project44, we recommend checking out our guides first: https://developers.project44.com/guides/shippers and https://developers.project44.com/guides/carriers.",
    "title": "project44 REST API",
    "version": "4.0.0",
    "x-logo": {
      "url": "/img/p44logo.png"
    }
  },
  "servers": [
    {
      "url": "https://na12.api.project44.com",
      "description": "NA - Endpoint for project44 tenants created in the NA region"
    },
    {
      "url": "https://eu12.api.project44.com",
      "description": "EU -  Endpoint for project44 tenants created in the EU region"
    },
    {
      "url": "https://na12.api.sandbox.p-44.com",
      "description": "Sandbox -  Endpoint for project44 tenants created in the sandbox environment"
    }
  ],
  "tags": [
    {
      "name": "Analytics: Port Intelligence",
      "description": "API for Port Intelligence."
    },
    {
      "name": "Appointments",
      "description": "Create, reschedule, cancel, fetch appointments in Yard Management Systems(YMS)"
    },
    {
      "name": "Asset Tracking",
      "description": "Track the location of an enrolled asset."
    },
    {
      "name": "Capacity",
      "description": "Get capacity for a YMS site within the specified time range"
    },
    {
      "name": "Capacity Provider Account Group Management",
      "description": "Manage capacity provider account groups. Groups are used to sort capacity provider accounts on a per customer or location basis.\n\n For example, you can add multiple capacity providers to a group if they all share lanes to the same origin/destination location.\n\n Another example, if certain customers receive different rates for a capacity provider, it may be reasonable to use separate groups  for each customer's capacity provider accounts. \n\nUse these APIs to create (POST), retrieve (GET) or delete (DELETE) capacity provider account groups."
    },
    {
      "name": "Capacity Provider Account Management",
      "description": "Manage capacity provider accounts where a capacity provider is typically used to represent a carrier. \n\n Capacity providers have capacity provider account definitions also known as capacity provider account types. Capacity provider accounts are arranged in sets where each set contains one or more accounts for the same capacity provider.  Each capacity provider's service is compatible with one and only one of these capacity provider accounts. Because most capacity providers have only one capacity provider account definition, most sets will contain only one capacity provider account. For capacity providers with more then one account definition, the set of accounts may consist of one account per account definition.\n\n For example, FedEx has a standard account to be used with LTL rating, LTL and Volume LTL dispatch, tracking, and imaging and a separate account for Volume LTL rating.  A set of FedEx capacity provider accounts may have a single standard account, a single volume LTL rating account, or both. Providing the capacity provider account set code in the request resolves which capacity provider account to use.\n\nCapacity provider specific credential information is available in the portal. \n\nUse these APIs to create (POST), retrieve (GET), update (POST) or delete (DELETE) capacity provider accounts."
    },
    {
      "name": "Capacity Provider Contact Management",
      "description": "Manage locations. Locations combine physical addresses with contact details and are used in configuring Capacity Provider Accounts and Stop Locations, for example to identify the Bill To party.\n\n Use these APIs to create (POST), update (PUT) or retrieve (GET) locations.\n\n These operations are also all available under the /locations endpoint for backward compatibility."
    },
    {
      "name": "Capacity Provider Metadata",
      "description": "Retrieve capacity provider information needed to set up capacity provider accounts."
    },
    {
      "name": "Filter Suggestions",
      "description": "..."
    },
    {
      "name": "Inventory Order and Load Webhook Data",
      "description": "Operations to describe the payload expected from project44 when integrated with a webhook for orders and loads."
    },
    {
      "name": "Invitations",
      "description": "..."
    },
    {
      "name": "LTL: Address Book",
      "description": "..."
    },
    {
      "name": "LTL: Dispatch",
      "description": "API used for scheduling LTL shipments."
    },
    {
      "name": "LTL: Electronic BOL",
      "description": "API used for creating Electronic BOL"
    },
    {
      "name": "LTL: Image Retrieval",
      "description": "Access shipment images."
    },
    {
      "name": "LTL: Push Imaging",
      "description": "As a capacity provider, push project44 images related to shipments."
    },
    {
      "name": "LTL: Push Tracking",
      "description": "As a capacity provider, push project44 shipments and status updates."
    },
    {
      "name": "LTL: Quotes",
      "description": "Quote LTL rates and retrieve transit times."
    },
    {
      "name": "LTL: Tracking",
      "description": "API used for the retrieval of shipment status."
    },
    {
      "name": "Milestones",
      "description": "Update yard milestones for a shipment"
    },
    {
      "name": "Multi-Modal: Booking",
      "description": "API used for multi-modal Booking."
    },
    {
      "name": "Multi-Modal: Document",
      "description": "..."
    },
    {
      "name": "Multi-Modal: Image Retrieval",
      "description": "Access shipment images."
    },
    {
      "name": "Multi-Modal: Packaging",
      "description": "API used for managing packages for shipment planning."
    },
    {
      "name": "Multi-Modal: Rating",
      "description": "API used for multi-modal Rating."
    },
    {
      "name": "OAuth 2.0: Client Applications",
      "description": "API used for registering and managing OAuth 2.0 client applications. See the \"Authentication\" section above for more information. To authorize API requests to project44 for an API integration, first your client application must be registered with project44, which will issue your application a client id and secret. These credentials can then be used to generate bearer tokens, which can be included on all other API requests to authorize your client application. The client application is authorized through the project44 user management UI as a machine user with username \"app-{client_id}@client-applications.project44.com\".\n\nAn admin user (with Movement user role \"Customer Admin\") must use HTTP Basic Authentication with this API to manage client applications. Basic Authentication is deprecated for all other APIs, besides token generation, in favor of passing the access token generated via OAuth 2.0."
    },
    {
      "name": "OAuth 2.0: Token Generation",
      "description": "API for OAuth 2.0 token generation. See the \"Authentication\" section above for more information. Once your client application is registered, you can use the token generation endpoint to authenticate with your application's client id and secret in exchange for a bearer token to be included on all other API requests to authenticate as that client application. The client application is authorized through the project44 user management UI as a machine user with username \"app-{client_id}@client-applications.project44.com\". \n\nTo generate an access token, you may authenticate your client application by providing its client id and secret either in the body of the request or in the form of HTTP Basic Authentication (but you may not use both ways in the same request)."
    },
    {
      "name": "Ocean: Tracking",
      "description": "..."
    },
    {
      "name": "Order Visibility",
      "description": "API used for orders and inventory items"
    },
    {
      "name": "Parcel: Push Tracking",
      "description": "..."
    },
    {
      "name": "Parcel: Tracking",
      "description": "Track parcel shipments. Before parcel shipments can be tracked, they must first be initialized with a shipment identifier.  Shipments cannot be modified once initialized and tracking has begun. To stop tracking a shipment, delete it. \n\nUse these APIs to initialize (POST), track (GET), or delete (DELETE) parcel shipments."
    },
    {
      "name": "Parcel: Webhook",
      "description": "Receive updates for a tracked parcel by defining a parcel-tracking-webhook."
    },
    {
      "name": "Postal Address Validation",
      "description": "..."
    },
    {
      "name": "Push Updates",
      "description": "..."
    },
    {
      "name": "Rail: Tracking",
      "description": "API used for accessing rail shipment tracking."
    },
    {
      "name": "Reason Codes",
      "description": "Retrieve all reason codes for the specified YMS site"
    },
    {
      "name": "Shipment Attributes",
      "description": "Create and fetch predefined custom attributes for shipments. You must be a organization admin to perform this operation."
    },
    {
      "name": "Shipment Search",
      "description": "..."
    },
    {
      "name": "Shipment Webhook Data",
      "description": "Operations to describe the payload expected from project44 when integrated with a webhook for shipments."
    },
    {
      "name": "Shipment: Loads",
      "description": "API used for tracking Loads."
    },
    {
      "name": "Shipment: Tracking",
      "description": "API used for Shipment Tracking."
    },
    {
      "name": "Site Codes",
      "description": "Retrieve all sites for the specified YMS tenant"
    },
    {
      "name": "Slots",
      "description": "Get available slots for a shipment in Yard Management Systems(YMS)"
    },
    {
      "name": "Stop Location Management",
      "description": "..."
    },
    {
      "name": "TL: Available Vehicles",
      "description": "API used for fetching vehicles within a specific radius and time window. Can only be used if opted into a project44 Co-Op."
    },
    {
      "name": "TL: Capacity Provider Push",
      "description": "As a capacity provider, push project44 shipment-related info and quotes."
    },
    {
      "name": "TL: Connected Capacity",
      "description": "API for finding new connected carrier partners in the project44 network based on tracking performance"
    },
    {
      "name": "TL: Tracking",
      "description": "project44's Truckload Tracking endpoints give you or your customers visibility into your truckload shipments, including such features as predictive ETAs and temperature tracking. Use these endpoints to initialize (POST), track (GET), update (PUT), cancel (POST) or delete(DELETE) truckload shipments. You can return shipment information by either unique system ID or by identifier."
    },
    {
      "name": "TL: Webhook",
      "description": "..."
    },
    {
      "name": "VLTL: Dispatch",
      "description": "API used for scheduling volume LTL shipments."
    },
    {
      "name": "VLTL: Quotes",
      "description": "API used for quoting volume LTL rates."
    },
    {
      "name": "Webhook",
      "description": "..."
    }
  ],
  "paths": {
    "/{webhook_endpoint_path_for_loads}": {
      "post": {
        "tags": [
          "Inventory Order and Load Webhook Data"
        ],
        "summary": "Example of load webhook payload.",
        "description": "This operation describes the payload for load that our service will send to your webhook endpoint. <p>**Note:** The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported **[Authentication Methods](/api-reference/webhook-guide/#authentication-method-fields)** as described in **[Webhook Guide](/api-reference/webhook-guide/)**.</p> </p> Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes. <ul> <li>**[Webhook Retry Logic](/api-reference/webhook-guide/#push-retry-logic)**</li> <li>**[Webhook Recommendations](/api-reference/webhook-guide/#webhook-recommendations)**</li></ul></p></p> Push to webhook is triggered when there is a change in any attribute of a load: <ul> <li>Creation, update or deletion of an load</li> </ul> </p> Push to webhook is <b>NOT</b> triggered for any cases that dont modify any load attributes: <ul> <li>Change in orders for the load</li> <li>Change in shipment for the load</li></ul></p>",
        "servers": [
          {
            "url": "https://{webhook_base_url}",
            "variables": {
              "webhook_base_url": {
                "default": "webhook.example.com",
                "description": "Base URL for the webhook"
              }
            }
          }
        ],
        "operationId": "LoadWebhookPush",
        "parameters": [
          {
            "name": "webhook_endpoint_path_for_loads",
            "in": "path",
            "description": "Your webhook path specified when creating your webhook configuration in the \"url\" field: e.g., url = \"https://{webhook_base_url}/{webhook_endpoint_path_for_loads}\" (**[Create or update a push configuration.](/api-reference/api-docs/webhook/createorupdatewebhookconfiguration)**).",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "JSON payload that will be sent to your webhook endpoint",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LoadWebhookPayload"
              },
              "example": {
                "eventId": "a3f7d821-4c6e-4b92-9d15-e8f203a76c41",
                "eventType": "inventory.v1.load.upserted",
                "createdDateTime": "2026-04-06T10:13:22+0000",
                "dataType": "Load",
                "data": {
                  "id": "b1e29c4f-83a7-4d05-c7f2-2d4810e59b63",
                  "pickupStopReference": {
                    "stopId": "c5d3e817-2f94-4a61-b8e0-7c1429d86f52"
                  },
                  "deliveryStopReference": {
                    "stopId": "d8f1a293-6e40-4c78-a5b1-9e3507f24d81"
                  },
                  "identifiers": [
                    {
                      "type": "BILL_OF_LADING",
                      "value": "BL-2026-0047832"
                    }
                  ],
                  "description": "Electronics shipment - fragile goods",
                  "createdDateTime": "2026-04-06T10:13:22+0000",
                  "lastModifiedDateTime": "2026-04-06T10:13:22+0000",
                  "masterShipmentId": "e2c6b405-9d71-4e83-f3a8-4b7618c93d25",
                  "items": [
                    {
                      "unitQuantity": 2,
                      "description": "Electronic Components",
                      "identifiers": [
                        {
                          "type": "STOCK_KEEPING_UNIT",
                          "value": "ELEC-COMP-4821"
                        },
                        {
                          "type": "UNIVERSAL_PRODUCT_CODE",
                          "value": "012345000891"
                        }
                      ],
                      "orderIdentifierReferences": [
                        {
                          "orderId": "47b2c914e73d5fa1cc60d8179204b5e320260406512",
                          "orderType": "PURCHASE_ORDER",
                          "orderIdentifier": "PO-2026-00421"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "201": {
            "description": "Created"
          },
          "202": {
            "description": "Accepted"
          },
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid payload or other client error"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/{webhook_endpoint_path_for_orders}": {
      "post": {
        "tags": [
          "Inventory Order and Load Webhook Data"
        ],
        "summary": "Example of order webhook payload.",
        "description": "This operation describes the payload for load that our service will send to your webhook endpoint. <p>**Note:** The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported **[Authentication Methods](/api-reference/webhook-guide/#authentication-method-fields)** as described in **[Webhook Guide](/api-reference/webhook-guide/)**.</p> </p> Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes. <ul> <li>**[Webhook Retry Logic](/api-reference/webhook-guide/#push-retry-logic)**</li> <li>**[Webhook Recommendations](/api-reference/webhook-guide/#webhook-recommendations)**</li></ul></p></p> Push to webhook is triggered when there is a change in any attribute of an order: <ul> <li>Creation, update or deletion of an order</li> <li>Update in order health or ETA</li> </ul> </p> Push to webhook is <b>NOT</b> triggered for any cases that donot modify any order attributes: <ul> <li>Any change in loads for the order</li> <li>Any change in shipment for the order</li> <li>Any change in items for the order</li> </ul></p>",
        "servers": [
          {
            "url": "https://{webhook_base_url}",
            "variables": {
              "webhook_base_url": {
                "default": "webhook.example.com",
                "description": "Base URL for the webhook"
              }
            }
          }
        ],
        "operationId": "OrderWebhookPush",
        "parameters": [
          {
            "name": "webhook_endpoint_path_for_orders",
            "in": "path",
            "description": "Your webhook path specified when creating your webhook configuration in the \"url\" field: e.g., url = \"https://{webhook_base_url}/{webhook_endpoint_path_for_orders}\" (**[Create or update a push configuration.](/api-reference/api-docs/webhook/createorupdatewebhookconfiguration/)**).",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "JSON payload that will be sent to your webhook endpoint",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderWebhookPayload"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "201": {
            "description": "Created"
          },
          "202": {
            "description": "Accepted"
          },
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid payload or other client error"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/{webhook_endpoint_path_legacy_FTL}": {
      "post": {
        "tags": [
          "Shipment Webhook Data"
        ],
        "summary": "Example of webhook payload for legacy Full Truckload.",
        "description": "This operation describes the payload that our service will send to your webhook endpoint. <p> <p>**Warning:** It is recommended to not use this way of ingesting data, the [main payload](/api-reference/api-docs/shipment-webhook-data/unifiedwebhookpush) should be preferred.</p> <p> **Note:** The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported **[Authentication Methods](/api-reference/webhook-guide/#authentication-method-fields)** as described in **[Webhook Guide](/api-reference/webhook-guide/)**.</p> </p> Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes. <ul> <li>**[Webhook Retry Logic](/api-reference/webhook-guide/#push-retry-logic)**</li> <li>**[Webhook Recommendations](/api-reference/webhook-guide/#webhook-recommendations)**</li></ul></p>",
        "servers": [
          {
            "url": "https://{webhook_base_url}",
            "variables": {
              "webhook_base_url": {
                "default": "webhook.example.com",
                "description": "Base URL for the webhook"
              }
            }
          }
        ],
        "operationId": "LegacyTLWebhookPush",
        "parameters": [
          {
            "name": "webhook_endpoint_path_legacy_FTL",
            "in": "path",
            "description": "Your webhook path specified when creating your webhook configuration in the \"url\" field: e.g., url = \"https://{webhook_base_url}/{webhook_endpoint_path}\" (**[Create or update a push configuration.](/api-reference/api-docs/webhook/createorupdatewebhookconfiguration/)**).",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "JSON payload that will be sent to your webhook endpoint",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipmentStatus"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "201": {
            "description": "Created"
          },
          "202": {
            "description": "Accepted"
          },
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid payload or other client error"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/{webhook_endpoint_path}": {
      "post": {
        "tags": [
          "Shipment Webhook Data"
        ],
        "summary": "Example of shipment webhook payload.",
        "description": "This operation describes the payload for shipment that our service will send to your webhook endpoint. <p>**Note:** The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported **[Authentication Methods](/api-reference/webhook-guide/#authentication-method-fields)** as described in **[Webhook Guide](/api-reference/webhook-guide/)**.</p> </p> Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes. <ul> <li>**[Webhook Retry Logic](/api-reference/webhook-guide/#push-retry-logic)**</li> <li>**[Webhook Recommendations](/api-reference/webhook-guide/#webhook-recommendations)**</li></ul></p>",
        "servers": [
          {
            "url": "https://{webhook_base_url}",
            "variables": {
              "webhook_base_url": {
                "default": "webhook.example.com",
                "description": "Base URL for the webhook"
              }
            }
          }
        ],
        "operationId": "UnifiedWebhookPush",
        "parameters": [
          {
            "name": "webhook_endpoint_path",
            "in": "path",
            "description": "Your webhook path specified when creating your webhook configuration in the \"url\" field: e.g., url = \"https://{webhook_base_url}/{webhook_endpoint_path}\" (**[Create or update a push configuration.](/api-reference/api-docs/webhook/createorupdatewebhookconfiguration/)**).",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "JSON payload that will be sent to your webhook endpoint",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackedShipmentHistory"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "201": {
            "description": "Created"
          },
          "202": {
            "description": "Accepted"
          },
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid payload or other client error"
          },
          "500": {
            "description": "Server error"
          }
        }
      }
    },
    "/api/v4/address/validate": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul>",
        "operationId": "validateAddress",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Address"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Address"
              }
            }
          },
          "description": "address",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Address"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Address"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Validate specified address.",
        "tags": [
          "Postal Address Validation"
        ]
      }
    },
    "/api/v4/analytics/port-intelligence/summary": {
      "get": {
        "description": "Retrieves port intelligence data for given ports. Clients must include header Accept: text/csv for CSV format, or else the JSON format will be returned.",
        "operationId": "getPortIntelligence",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Query for port intelligence. Takes 1 to 10 UN/LOCODE codes separated by a comma.",
            "in": "query",
            "name": "locodes",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortIntelligenceCollection"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/PortIntelligenceCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for Port Intelligence.",
        "tags": [
          "Analytics: Port Intelligence"
        ]
      }
    },
    "/api/v4/assets/tracking": {
      "delete": {
        "description": "Unenroll an asset from tracking. Information about the location of the asset will no longer be pushed. \n<b>Required Query Parameters <ul> <li>equipmentIdentifier.type: the asset type (either CONTAINER_ID, RAIL_CAR_ID, or TRAILER_ID) </li> <li>equipmentIdentifier.value: the unique identifier of the asset, e.g., BNSF654321</li> </ul> <br/> <p>The call will return with an HTTP 200 status if unenrollment is successful. Otherwise, it will return an appropriate HTTP error status code and error message.</p>",
        "operationId": "unenrollAsset",
        "parameters": [
          {
            "description": "equipmentIdentifier.type",
            "in": "query",
            "name": "equipmentIdentifier.type",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "equipmentIdentifier.value",
            "in": "query",
            "name": "equipmentIdentifier.value",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Unenroll an asset for tracking.",
        "tags": [
          "Asset Tracking"
        ]
      },
      "post": {
        "description": "The Asset Tracking API offers users a way to enroll an asset for tracking, and conversely, to unenroll an asset from tracking. Prior to enrolling an asset, users must have an endpoint configured to receive the asset location data. \n\nInformation about the location of the asset will be pushed to the enrollee until the asset is un-enrolled from tracking. The payload can be JSON or XML, e.g., <pre>{ \n&nbsp;&nbsp;\"webhookName\": \"KBX001\", \n&nbsp;&nbsp;\"equipmentIdentifier\": {\"type\": \"RAIL_CAR_ID\", \"value\": \"ABCD1234567\"}, \n&nbsp;&nbsp;\"expirationDateTime\": \"2019-05-01T00:00:00-05:00\" \n} \n</pre> OR <pre>&lt;AssetTrackingSubscription&gt; \n&nbsp;&nbsp;&lt;webhookName&gt;KBX001&lt;/webhookName&gt; \n&nbsp;&nbsp;&lt;equipmentIdentifier&gt; \n&nbsp;&nbsp;&nbsp;&nbsp;&lt;type&gt;RAIL_CAR_ID&lt;/type&gt; \n&nbsp;&nbsp;&nbsp;&nbsp;&lt;value&gt;ABCD1234567&lt;/value&gt; \n&nbsp;&nbsp;&lt;/equipmentIdentifier&gt; \n&nbsp;&nbsp;&lt;expirationDateTime&gt;2019-05-01T00:00:00-05:00&lt;/expirationDateTime&gt; \n&lt;/AssetTrackingSubscription&gt; \n</pre>  <br/> <p>The call will return with an HTTP 200 status if enrollment is successful. Otherwise, it will return an appropriate HTTP error status code and error message.</p> <br/> <b>Required Fields</b> \n<ul> <li>equipmentIdentifier: The type of asset (either CONTAINER_ID, RAIL_CAR_ID, or TRAILER_ID) and unique identifier, e.g., BNSF654321.</li> <li>webhookName: The id of the previously registered webhook. This indicates where to send the asset tracking information..</li> </ul> <b>Optional Field</b> \n<ul> <li>expirationDateTime: Optional parameter to indicate when to stop tracking the asset. If not provided, expiration will default to six months from the enrollment date. The format is a date-time string with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2020-05-01T00:00:00-05:00.</li> </ul>",
        "operationId": "enrollAsset",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetTrackingSubscription"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/AssetTrackingSubscription"
              }
            }
          },
          "description": "subscription",
          "required": true
        },
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Enroll an asset for tracking.",
        "tags": [
          "Asset Tracking"
        ]
      }
    },
    "/api/v4/capacityprovideraccountgroups": {
      "get": {
        "description": "Each capacity provider account group returned in the response includes a unique id that can be used as reference in other APIs.",
        "operationId": "queryCapacityProviderAccountGroup",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountGroupInfoCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountGroupInfoCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the current list of all available capacity provider account groups.",
        "tags": [
          "Capacity Provider Account Group Management"
        ]
      },
      "post": {
        "description": "The capacity provider account group requires a unique code and may use an optional name. The response will include a unique id that can be used to reference the capacity provider account group in other APIs.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> name </li><li> code </li></ul>",
        "operationId": "createCapacityProviderAccountGroupInfo",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
              }
            }
          },
          "description": "capacityProviderAccountGroupInfo",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a new capacity provider account group.",
        "tags": [
          "Capacity Provider Account Group Management"
        ]
      }
    },
    "/api/v4/capacityprovideraccountgroups/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteCapacityProviderAccountGroupInfo",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete the capacity provider account group.",
        "tags": [
          "Capacity Provider Account Group Management"
        ]
      }
    },
    "/api/v4/capacityprovideraccounts": {
      "get": {
        "description": "Each capacity provider account infos object returned in the response includes a unique ID that can be used as a reference in other APIs. It's important to note that we no longer send decrypted credentials through this service. A maximum of 1000 objects may be returned from a single API call.",
        "operationId": "queryListCapacityProviderAccountInfos",
        "parameters": [
          {
            "description": "accountGroupCode",
            "in": "query",
            "name": "accountGroupCode",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfosCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfosCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the current list of all available capacity provider account infos.",
        "tags": [
          "Capacity Provider Account Management"
        ]
      },
      "post": {
        "description": "The capacity provider account uses the capacity provider account infos object. No more then 1000 accounts may belong to any account group.Use the \"Capacity Provider Metadata\" API to get account definition information for a capacity provider.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> code </li><li><b>  capacityProviderIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  accounts: </b></li><ul><li> accountDefinitionIdentifier </li><li> (use \"Capacity Provider Metadata\" API to determine which fields are required for a given account type) </li></ul></ul>",
        "operationId": "createCapacityProviderAccountInfos",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountInfos"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountInfos"
              }
            }
          },
          "description": "capacityProviderAccountInfos",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a capacity provider account.",
        "tags": [
          "Capacity Provider Account Management"
        ]
      }
    },
    "/api/v4/capacityprovideraccounts/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteCapacityProviderAccountInfos",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete capacity provider account infos.",
        "tags": [
          "Capacity Provider Account Management"
        ]
      },
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "querySingleCapacityProviderAccountInfos",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the infos object for a single capacity provider.",
        "tags": [
          "Capacity Provider Account Management"
        ]
      },
      "put": {
        "description": "The capacity provider account uses the capacity provider account infos object.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li><li> code </li><li><b>  capacityProviderIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  accounts: </b></li><ul><li> accountDefinitionIdentifier </li><li> (use \"Capacity Provider Metadata\" API to determine which fields are required for a given account type) </li></ul></ul>",
        "operationId": "updateCapacityProviderAccountInfos",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountInfos"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/CapacityProviderAccountInfos"
              }
            }
          },
          "description": "capacityProviderAccountInfos",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderAccountInfos"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update the capacity provider account.",
        "tags": [
          "Capacity Provider Account Management"
        ]
      }
    },
    "/api/v4/capacityproviders": {
      "get": {
        "description": "Provides a list of all capacity providers for which accounts can be set up within project44. \n\nNote that in some cases, like with truckload tracking, a capacity provider account is not needed to connect to a capacity provider -- e.g., if project44 has an ELD connection set up with that capacity provider directly. In these cases, that capacity provider will not currently be returned by this API. This API is solely for capacity providers requiring account information.",
        "operationId": "findCapacityProviders",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get a list of all capacity providers for which accounts can be set up.",
        "tags": [
          "Capacity Provider Metadata"
        ]
      }
    },
    "/api/v4/capacityproviders/ltl/shipments": {
      "put": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  customerAccount: </b></li><ul><li> accountIdentifier </li></ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li><li> primaryForType (if more than one shipment identifier of the same type)</li></ul></ul>",
        "operationId": "upsertShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlCapacityProviderPushShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlCapacityProviderPushShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Upsert shipment details.",
        "tags": [
          "LTL: Push Tracking"
        ]
      }
    },
    "/api/v4/capacityproviders/ltl/shipments/images": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  customerAccount: </b></li><ul><li> accountIdentifier </li></ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li> imageFormat </li><li> documentType </li><li><b>  imagePages: </b></li><ul><li> imageUrl (if no imageData provided)</li><li> imageData (if no imageUrl provided)</li><li> pageNumber (if more then one page provided) </li></ul></ul>",
        "operationId": "createShipmentDocumentImage",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentImage"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentImage"
              }
            }
          },
          "description": "shipmentImage",
          "required": true
        },
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create image of shipment document.",
        "tags": [
          "LTL: Push Imaging"
        ]
      }
    },
    "/api/v4/capacityproviders/ltl/shipments/statusupdates": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  customerAccount: </b></li><ul><li> accountIdentifier </li></ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li><li> primaryForType (if more than one shipment identifier of the same type)</li></ul><li> statusCode </li><li><b>  location: </b>(if statusCode is 'ARRIVED_AT_TERMINAL' or 'DEPARTED_TERMINAL')</li><ul><li><b>  address: </b>(if location provided)</li><ul><li> city (if location provided)</li><li> state (if location provided and country is US)</li><li> country (if location provided and country is not US. Default: US)</li></ul></ul><li><b> deliveryAppointmentWindow: </b>(if statusCode is 'UPDATED_DELIVERY_APPT')</li><li> timestamp </li></ul>",
        "operationId": "createStatusUpdate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlCapacityProviderPushStatusUpdate"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlCapacityProviderPushStatusUpdate"
              }
            }
          },
          "description": "statusUpdate",
          "required": true
        },
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create status updates for a shipment.",
        "tags": [
          "LTL: Push Tracking"
        ]
      }
    },
    "/api/v4/capacityproviders/metadata": {
      "get": {
        "description": "Provides metadata about capacity providers for which capacity provider accounts can be created within project44. This API works alongside the capacity provider account management APIs, providing the services supported by each capacity provider and the fields needed to create an account with one, along with what that capacity provider calls these fields in their system to make finding the necessary account information easy. \n\nNote that in some cases, like with truckload tracking, a capacity provider account is not needed to connect to a capacity provider -- e.g., if project44 has an ELD connection set up with that capacity provider directly. In these cases, that capacity provider will not currently be returned by this API. This API is solely for capacity providers requiring account information.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> capacityProviderIdentifier.type </li><li> capacityProviderIdentifier.value </li></ul>",
        "operationId": "findCapacityProviderMetadata",
        "parameters": [
          {
            "description": "Capacity provider identifier type.",
            "in": "query",
            "name": "capacityProviderIdentifier.type",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "description": "Capacity provider identifier value.",
            "in": "query",
            "name": "capacityProviderIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderMetadata"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityProviderMetadata"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get metadata for a specific capacity provider.",
        "tags": [
          "Capacity Provider Metadata"
        ]
      }
    },
    "/api/v4/capacityproviders/parcel/shipments/statusupdates": {
      "post": {
        "description": "This endpoint allows for carriers to send tracking data to project44.",
        "operationId": "createParcelStatusUpdate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ParcelCapacityProviderPushStatusUpdate"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/ParcelCapacityProviderPushStatusUpdate"
              }
            }
          },
          "description": "statusUpdate",
          "required": true
        },
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "This endpoint allows for carriers to send tracking data to project44.",
        "tags": [
          "Parcel: Push Tracking"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/equipmentIdentifierAssignments": {
      "post": {
        "operationId": "postEquipmentIdentifierAssignmentUsingPOST",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadEquipmentIdentifierAssignment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadEquipmentIdentifierAssignment"
              }
            }
          },
          "description": "truckloadEquipmentIdentifierAssignment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadEquipmentIdentifierAssignment"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadEquipmentIdentifierAssignment"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "postEquipmentIdentifierAssignment",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/events": {
      "post": {
        "operationId": "createTruckloadShipmentEventUsingPOST",
        "parameters": [
          {
            "description": "shipmentLegId",
            "in": "path",
            "name": "shipmentLegId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackedShipmentEvent"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TrackedShipmentEvent"
              }
            }
          },
          "description": "shipmentEvent",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrackedShipmentEvent"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TrackedShipmentEvent"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "createTruckloadShipmentEvent",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/stops/{stopId}/additional-appointment-windows": {
      "put": {
        "operationId": "updateTruckloadAdditionalAppointmentWindowUsingPUT",
        "parameters": [
          {
            "description": "shipmentLegId",
            "in": "path",
            "name": "shipmentLegId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "stopId",
            "in": "path",
            "name": "stopId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindow"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindow"
              }
            }
          },
          "description": "additionalAppointmentWindow",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindow"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindow"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "updateTruckloadAdditionalAppointmentWindow",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/shipments/intermediateStops": {
      "post": {
        "operationId": "postIntermediateStopsUsingPOST",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadIntermediateStopsUpdate"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadIntermediateStopsUpdate"
              }
            }
          },
          "description": "intermediateStopsUpdate",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadIntermediateStopsUpdate"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadIntermediateStopsUpdate"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "postIntermediateStops",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/shipments/statusUpdates": {
      "post": {
        "description": "This endpoint allows for carriers to send tracking data to project44",
        "operationId": "postStatusUpdate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderPushStatusUpdate"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderPushStatusUpdate"
              }
            }
          },
          "description": "statusUpdate",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderPushStatusUpdate"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderPushStatusUpdate"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "TL: Carrier Push Tracking",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/acceptances": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li>  tenderIdentifier </li><li>  capacityProviderOfferIdentifier </li><li>  offerExpirationDateTime </li></ul>",
        "operationId": "postTenderAcceptance",
        "parameters": [
          {
            "description": "The capacity provider's identifier for the tender being accepted.",
            "in": "path",
            "name": "tenderIdentifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderAcceptance"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderAcceptance"
              }
            }
          },
          "description": "tenderAcceptance",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderAcceptanceConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderAcceptanceConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Accept a shipper's request to handle a shipment tender.",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/declines": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li>  tenderIdentifier </li></ul>",
        "operationId": "postTenderDecline",
        "parameters": [
          {
            "description": "The capacity provider's identifier for the tender being declined.",
            "in": "path",
            "name": "tenderIdentifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderDecline"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderDecline"
              }
            }
          },
          "description": "tenderDecline",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderDeclineConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderDeclineConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Decline the opportunity to bid on a particular shipment tender.",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/errors": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li>  tenderIdentifier </li></ul>",
        "operationId": "postTenderError",
        "parameters": [
          {
            "description": "The capacity provider's identifier for the tender having an error.",
            "in": "path",
            "name": "tenderIdentifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderError"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderError"
              }
            }
          },
          "description": "tenderError",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderErrorConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderErrorConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Reject the particular shipment tender due to an error with the tendering data.",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/quotes": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li>  tenderIdentifier </li><li>  capacityProviderOfferIdentifier </li><li>  offerExpirationDateTime </li><li>  <b> rateQuoteDetail </b></li></ul>",
        "operationId": "postTenderQuotes",
        "parameters": [
          {
            "description": "The capacity provider's identifier for the tender being quoted.",
            "in": "path",
            "name": "tenderIdentifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderRateQuote"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadCapacityProviderTenderRateQuote"
              }
            }
          },
          "description": "rateQuote",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderRateQuoteConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadCapacityProviderTenderRateQuoteConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Provide a rate quote in response to a shipment tender.",
        "tags": [
          "TL: Capacity Provider Push"
        ]
      }
    },
    "/api/v4/contacts": {
      "get": {
        "description": "Each contact location returned in the response includes a unique id that can be used as reference in other APIs.",
        "operationId": "listContacts",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the current list of all available contact locations.",
        "tags": [
          "Capacity Provider Contact Management"
        ]
      },
      "post": {
        "description": "A contact location consists of an address and other contact info. Note that duplicate locations are allowed although each will be given a unique id which is returned here in the response.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul>",
        "operationId": "createContact",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a new contact.",
        "tags": [
          "Capacity Provider Contact Management"
        ]
      }
    },
    "/api/v4/contacts/{id}": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getContact",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the contact location associated with the provided id.",
        "tags": [
          "Capacity Provider Contact Management"
        ]
      },
      "put": {
        "description": "The response reflects the changes made to the contact location.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul>",
        "operationId": "updateContact",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update the specified contact.",
        "tags": [
          "Capacity Provider Contact Management"
        ]
      }
    },
    "/api/v4/images/query": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b>  destinationAddress: </b></li><ul><li> postalCode </li></ul><li> documentType </li><li> mode </li></ul>",
        "operationId": "queryImages",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MultiModalImageQuery"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/MultiModalImageQuery"
              }
            }
          },
          "description": "multiModalImageQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MultiModalImageReference"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/MultiModalImageReference"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for shipment images.",
        "tags": [
          "Multi-Modal: Image Retrieval"
        ]
      }
    },
    "/api/v4/inventory/items": {
      "post": {
        "description": "InventoryItem should be passed without populating the id field. A unique id will be generated and returned in the response. This id will be used to identify the item across all other methods.  This method will return 202 Accepted when the item has been queued for creation. The item is created asynchronously.",
        "operationId": "createItem",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryItem"
              }
            }
          },
          "description": "item",
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create an item.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/items/{id}": {
      "delete": {
        "description": "Use InventoryItem.id to delete the InventoryItem.",
        "operationId": "deleteItem",
        "parameters": [
          {
            "description": "The project44-generated id of the item you wish to delete.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete an item.",
        "tags": [
          "Order Visibility"
        ]
      },
      "get": {
        "description": "Use the id returned from createItem to retrieve the InventoryItem.",
        "operationId": "getItem",
        "parameters": [
          {
            "description": "The project44-generated id of the item you wish to query.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryItem"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryItem"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get an item by project44 id.",
        "tags": [
          "Order Visibility"
        ]
      },
      "put": {
        "description": "InventoryItem should be passed with the id field populated with the value returned from createItem. InventoryItems returned from the service will have id populated. InventoryItem.id must match the id in the URL. This method will return 202 Accepted when the item has been queued for update. The item is updated asynchronously.\n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "updateItem",
        "parameters": [
          {
            "description": "The project44-generated id of the item you wish to update.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryItem"
              }
            }
          },
          "description": "item",
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update an existing item.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/items/bulk": {
      "post": {
        "operationId": "createItemsUsingPOST",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryItemList"
              }
            }
          },
          "description": "items",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryIdList"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryIdList"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "createItems",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/items/search": {
      "post": {
        "description": "Use the BasicInventoryItemSearchCriteria, page number, page size and sort field to perform Inventory Item search",
        "operationId": "searchItems",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Page number valid range: [1, 50]",
            "in": "query",
            "name": "page",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page size valid range: [1, 100]",
            "in": "query",
            "name": "size",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Inventory Sortable Fields: [stockKeepingUnit, description, universalProductCode, inventoryIdentifiers.type, manufacturedDateTime, packagedDateTime, sellByDateTime, consumeByDateTime, lineItemHazmatDetail.hazardClass]",
            "in": "query",
            "name": "sort",
            "schema": {
              "default": "stockKeepingUnit:ASC",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BasicInventoryItemSearchCriteria"
              }
            }
          },
          "description": "criteria",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryItemPage"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryItemPage"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Search for items.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/orders": {
      "post": {
        "description": "InventoryOrder should be passed without populating the id field. A unique id will be generated and returned in the response. This id will be used to identify the order across all other methods.  This method will return 202 Accepted when the order has been queued for creation. The order is created asynchronously.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> orderIdentifier </li></ul>",
        "operationId": "createOrder",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryOrder"
              }
            }
          },
          "description": "order",
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create an order.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/orders/{id}": {
      "delete": {
        "description": "Use InventoryOrder.id to delete the InventoryOrder.",
        "operationId": "deleteOrder",
        "parameters": [
          {
            "description": "The project44-generated id of the order you wish to delete.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete an order.",
        "tags": [
          "Order Visibility"
        ]
      },
      "get": {
        "description": "Use the id returned from createOrder to retrieve the InventoryOrder.",
        "operationId": "getOrder",
        "parameters": [
          {
            "description": "The project44-generated id of the order you wish to query.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryOrder"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryOrder"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve an order by project44 id.",
        "tags": [
          "Order Visibility"
        ]
      },
      "put": {
        "description": "InventoryOrder should be passed with the id field populated with the value returned from createOrder. Orders returned from the service will have id populated. InventoryOrder.id must match the id in the URL. This method will return 202 Accepted when the order has been queued for update. The order is updated asynchronously.\n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li><li> orderIdentifier </li></ul>",
        "operationId": "updateOrder",
        "parameters": [
          {
            "description": "The project44-generated id of the order you wish to update.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryOrder"
              }
            }
          },
          "description": "order",
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryId"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update an existing order.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/orders/{id}/related-orders": {
      "get": {
        "description": "Use the InventoryOrder.id (project44 generated id) from an existing order to retrieve all related orders.",
        "operationId": "getRelatedOrders",
        "parameters": [
          {
            "description": "The project44-generated id of the order for which you wish to query related orders.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page number valid range: [1, 50]",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 1,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page size valid range: [1, 100]",
            "in": "query",
            "name": "size",
            "schema": {
              "default": 30,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Order Sortable Fields: [orderType, orderIdentifier, statusCode, orderSubmissionDateTime, supplierReadyDateTimeWindow.startDateTime, supplierReadyDateTimeWindow.endDateTime, originalDeliveryDateTimeWindow.startDateTime,originalDeliveryDateTimeWindow.endDateTime, derivedOrderHealth.estimatedTimeOfArrival]",
            "in": "query",
            "name": "sort",
            "schema": {
              "default": "orderSubmissionDateTime:DESC",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Page_InventoryOrder_"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Page_InventoryOrder_"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get related orders.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/inventory/orders/search": {
      "post": {
        "description": "Use the BasicInventoryOrderSearchCriteria, page number, page size and sort field to perform Inventory Order search.",
        "operationId": "searchOrders",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Page number valid range: [1, 50]",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 1,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page size valid range: [1, 1000]",
            "in": "query",
            "name": "size",
            "schema": {
              "default": 30,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Order Sortable Fields: [orderType, orderIdentifier, statusCode, orderSubmissionDateTime, supplierReadyDateTimeWindow.startDateTime, supplierReadyDateTimeWindow.endDateTime, originalDeliveryDateTimeWindow.startDateTime,originalDeliveryDateTimeWindow.endDateTime, derivedOrderHealth.estimatedTimeOfArrival]",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BasicInventoryOrderSearchCriteria"
              }
            }
          },
          "description": "criteria",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryOrderPage"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryOrderPage"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Search for orders.",
        "tags": [
          "Order Visibility"
        ]
      }
    },
    "/api/v4/loads": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  identifiers: </b> (at least one) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "createLoad",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Load"
              }
            }
          },
          "description": "load",
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LoadId"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LoadId"
                }
              }
            },
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a load.",
        "tags": [
          "Shipment: Loads"
        ]
      }
    },
    "/api/v4/loads/{loadId}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> loadId </li></ul>",
        "operationId": "deleteLoad",
        "parameters": [
          {
            "description": "loadId",
            "in": "path",
            "name": "loadId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete a load.",
        "tags": [
          "Shipment: Loads"
        ]
      },
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> loadId </li></ul>",
        "operationId": "getLoad",
        "parameters": [
          {
            "description": "loadId",
            "in": "path",
            "name": "loadId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Load"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Load"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get a load by load id.",
        "tags": [
          "Shipment: Loads"
        ]
      },
      "put": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> loadId </li><li> masterShipmentId </li><li><b>  identifiers: </b> (at least one) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "updateLoad",
        "parameters": [
          {
            "description": "loadId",
            "in": "path",
            "name": "loadId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Load"
              }
            }
          },
          "description": "load",
          "required": true
        },
        "responses": {
          "202": {
            "content": {},
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update a load.",
        "tags": [
          "Shipment: Loads"
        ]
      }
    },
    "/api/v4/locations": {
      "get": {
        "description": "Each location returned in the response includes a unique id that can be used as reference in other APIs.",
        "operationId": "listLocations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LocationCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the current list of all available locations.",
        "tags": [
          "LTL: Address Book"
        ]
      },
      "post": {
        "description": "A location consists of an address and an optional contact. Note that duplicate locations are allowed although each will be given a unique id which is returned here in the response.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul>",
        "operationId": "createLocation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a new location.",
        "tags": [
          "LTL: Address Book"
        ]
      }
    },
    "/api/v4/locations/{id}": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getLocation",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the location associated with the provided id.",
        "tags": [
          "LTL: Address Book"
        ]
      },
      "put": {
        "description": "The response reflects the changes made to the location.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul>",
        "operationId": "updateLocation",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Location"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Location"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update the specified location.",
        "tags": [
          "LTL: Address Book"
        ]
      }
    },
    "/api/v4/ltl/dispatchedshipments": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  originLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default origin contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b>  destinationLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default destination contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b>  requesterLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default requester contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul><li><b>  lineItems: </b></li><ul><li> totalWeight </li><li><b>  packageDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClass </li><li><b>  hazmatDetail: </b> (if line item contains hazardous materials)</li><ul><li> identificationNumber </li><li> properShippingName </li><li> hazardClass </li><li> packingGroup </li></ul></ul><li><b>  enhancedHandlingUnits <u> NOTE: PLEASE CONTACT YOUR ACCOUNT MANAGER AT PROJECT44 BEFORE USING.</u></b> </b></li><ul><li> weightPerHandlingUnit </li><li> pickupStopNumber </li><li> deliveryStopNumber </li><li><b>  handlingUnitDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClasses </li><li><b> packages </b></li><ul><li> <b> packageContents </b></li><ul><li><b>  hazmatDetail: </b> (if line item contains hazardous materials)</li></li><ul><li> identificationNumber </li><li> properShippingName </li><li> hazardClass </li><li> packingGroup </li></ul></ul></li></ul></ul><li><b>  pickupWindow: </b></li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li><b>  deliveryWindow: </b> (by some capacity providers if requesting guaranteed or expedited services)</li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li> carrierCode (if capacity provider supports multiple SCACs) </li><li><b>  emergencyContact: </b> (if shipment contains hazardous materials)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul><li> capacityProviderQuoteNumber (by a few capacity providers only) </li></ul>",
        "operationId": "createShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlDispatchedShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlDispatchedShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlDispatchedShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlDispatchedShipmentConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a shipment.",
        "tags": [
          "LTL: Dispatch"
        ]
      }
    },
    "/api/v4/ltl/images/query": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li> proNumber </li><li><b>  destinationAddress: </b></li><ul><li> postalCode </li></ul><li> documentType </li></ul>",
        "operationId": "queryLtlImages",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlImageQuery"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlImageQuery"
              }
            }
          },
          "description": "ltlImageQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlImageReference"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlImageReference"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for LTL shipment images.",
        "tags": [
          "LTL: Image Retrieval"
        ]
      }
    },
    "/api/v4/ltl/quotes/rates/query": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  originAddress: </b></li><ul><li> postalCode </li></ul><li><b>  destinationAddress: </b></li><ul><li> postalCode </li></ul><li><b>  lineItems: </b></li><ul><li> totalWeight </li><li><b>  packageDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClass </li></ul><li><b>  enhancedHandlingUnits <u> NOTE: PLEASE CONTACT YOUR ACCOUNT MANAGER AT PROJECT44 BEFORE USING.</u></b></li><ul><li> weightPerHandlingUnit </li><li> pickupStopNumber </li><li> deliveryStopNumber </li><li><b>  handlingUnitDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClasses </li></ul></ul>",
        "operationId": "queryLtlRateQuotes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RateQuoteQuery"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/RateQuoteQuery"
              }
            }
          },
          "description": "rateQuoteQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateQuoteCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/RateQuoteCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for rate quotes.",
        "tags": [
          "LTL: Quotes"
        ]
      }
    },
    "/api/v4/ltl/quotes/transittimes/query": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  originAddress: </b></li><ul><li> postalCode </li></ul><li><b>  destinationAddress: </b></li><ul><li> postalCode </li></ul></ul>",
        "operationId": "queryLtlTransitTimeQuotes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TransitTimeQuoteQuery"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TransitTimeQuoteQuery"
              }
            }
          },
          "description": "transitTimeQuoteQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransitTimeQuoteCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TransitTimeQuoteCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for transit time quotes.",
        "tags": [
          "LTL: Quotes"
        ]
      }
    },
    "/api/v4/ltl/shipments/{id}/cancellations": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  originAddress: </b></li><ul><li> postalCode </li></ul></ul>",
        "operationId": "cancelLtlDispatchedShipmentById",
        "parameters": [
          {
            "description": "The project44-generated id of the dispatched LTL shipment to be cancelled.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlShipmentCancellation"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlShipmentCancellation"
              }
            }
          },
          "description": "shipmentCancellation",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentCancellationConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentCancellationConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Cancel a dispatched shipment by id.",
        "tags": [
          "LTL: Dispatch"
        ]
      }
    },
    "/api/v4/ltl/shipments/cancellations": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  originAddress: </b></li><ul><li> postalCode </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "cancelLtlDispatchedShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlShipmentCancellation"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlShipmentCancellation"
              }
            }
          },
          "description": "shipmentCancellation",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentCancellationConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentCancellationConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Cancel a dispatched shipment by shipment identifier.",
        "tags": [
          "LTL: Dispatch"
        ]
      }
    },
    "/api/v4/ltl/trackedshipments": {
      "post": {
        "description": "Use this POST call to start a tracking job, initializing LTL tracking. The tracking job will run for a given duration (designated with the startDateTime and endDateTime parameters), gathering updates from the carrier and reference numbers detailed in the API call. Once a tracking update has been pulled from the carrier into the project44 tracking job, you can access the information via the GET requests below this endpoint. Note that if your dispatch was done through project44, you do not need to initialize tracking. project44 will implicitly start tracking based on the data provided in the dispatch.\n\n<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li><li> primaryForType (if more than one shipment identifier of the same type) </li></ul><li><b>  shipmentStops: </b> (two stops of types ORIGIN and DESTINATION) </li><ul><li> stopType </li><li><b>  location: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li></ul></ul><li><b>  appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul></ul></ul><b>NOTE:</b> The appointmentWindow object in shipmentStops does not support a localTimeZoneIdentifier due to an automated project44 process that detects time zone based on the stop's location. Please make sure to provide startDateTime and endDateTime in local time.",
        "operationId": "createLtlTrackedShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlTrackedShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlTrackedShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlTrackedShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlTrackedShipmentConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Start tracking an LTL shipment",
        "tags": [
          "LTL: Tracking"
        ]
      }
    },
    "/api/v4/ltl/trackedshipments/{id}": {
      "delete": {
        "description": "Use this endpoint to delete a tracked shipment with the given id. For example, you could delete a shipment that has been canceled or was never picked up.",
        "operationId": "deleteLtlTrackedShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the LTL tracked shipment you wish to be deleted.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete shipment by ID.",
        "tags": [
          "LTL: Tracking"
        ]
      },
      "put": {
        "description": "Use this endpoint to update a shipment. To achieve this, this endpoint deletes the current shipment and creates a new shipment on which it will begin tracking. This updates how we track the shipment but will not affect the dispatch with the carrier. Note that you must pass the entire details for the shipment, just as you would on a POST.  Note that you only need to update a shipment when the carrier, time, or date has changed.\n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li><li> primaryForType (if more than one shipment identifier of the same type) </li></ul><li><b>  shipmentStops: </b> (two stops of types ORIGIN and DESTINATION) </li><ul><li> stopType </li><li><b>  location: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b></li><ul><li> companyName </li></ul></ul><li><b>  appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul></ul></ul>",
        "operationId": "updateLtlTrackedShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the LTL tracked shipment you wish to update.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlTrackedShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlTrackedShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlTrackedShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Updates an LTL shipment",
        "tags": [
          "LTL: Tracking"
        ]
      }
    },
    "/api/v4/ltl/trackedshipments/{id}/statuses": {
      "get": {
        "description": "Use this endpoint to return the status of an LTL shipment according to a given unique system ID, provided in the parameters of the call. ",
        "operationId": "getLtlShipmentStatus",
        "parameters": [
          {
            "description": "The project44-generated id of the tracked or dispatched LTL shipment you wish to query.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Set to \"TRUE\" if you wish to receive a publicly accessible URL to the shipment details in the response.",
            "in": "query",
            "name": "includeMapUrl",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Set to \"TRUE\" if you wish to receive the shipment status history ('statusUpdates') in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Returns the status of an LTL shipment by unique system ID ",
        "tags": [
          "LTL: Tracking"
        ]
      }
    },
    "/api/v4/ltl/trackedshipments/statuses": {
      "get": {
        "description": "Use this endpoint to return the status of an LTL shipment according to a given identifier value. Note that this endpoint may return multiple shipments if the identifier is used for multiple shipments such as with a pickup number.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> shipmentIdentifier.type </li><li> shipmentIdentifier.value </li></ul>",
        "operationId": "getLtlShipmentStatusesByIdentifier",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Set to \"TRUE\" if you wish to receive the shipment status history ('statusUpdates') in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The source system that created the identifier.",
            "in": "query",
            "name": "shipmentIdentifier.source",
            "schema": {
              "enum": [
                "CUSTOMER",
                "CAPACITY_PROVIDER"
              ],
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The type of identifier for which to search.",
            "in": "query",
            "name": "shipmentIdentifier.type",
            "schema": {
              "enum": [
                "PRO",
                "BILL_OF_LADING",
                "CUSTOMER_REFERENCE",
                "PICKUP",
                "PURCHASE_ORDER",
                "EXTERNAL"
              ],
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The identifier value for which to search.",
            "in": "query",
            "name": "shipmentIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentStatusCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlShipmentStatusCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Returns the status of an LTL shipment by identifier.",
        "tags": [
          "LTL: Tracking"
        ]
      }
    },
    "/api/v4/oauth2/client-applications": {
      "get": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Get client applications.",
        "description": "List all client applications registered in your project44 account.",
        "operationId": "getApplications",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClientApplicationCollection"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      },
      "post": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Register client application.",
        "description": "Register a new client application, in order to receive a client id and secret that can be used to authenticate with project44's OAuth 2.0 token generation endpoint. Generate tokens to access other project44 APIs. Note you must record the client secret returned here securely as it cannot be retrieved again. You can, however, generate a new client secret via the \"new-secret\" endpoint in case you forget it or need to rotate it.\n<h4><b>Required Fields</h4></b>\n<ul><li> name </li></ul>",
        "operationId": "createApplication",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClientApplication"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClientApplication"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    },
    "/api/v4/oauth2/client-applications/{clientId}": {
      "get": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Get client application.",
        "description": "Get a specific client application by client id.\n<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getApplication",
        "parameters": [
          {
            "name": "clientId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClientApplication"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      },
      "put": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Update client application.",
        "description": "Update the name of an existing client application by id. The secret cannot be updated by the client. To generate a new secret, use the \"new-secret\" endpoint.\n<h4><b>Required Fields</h4></b>\n<ul><li> id </li><li> name </li></ul>",
        "operationId": "updateApplication",
        "parameters": [
          {
            "name": "clientId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClientApplication"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClientApplication"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      },
      "delete": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Delete client application.",
        "description": "Delete an existing client application by id. Deleting an application invalidates its client credentials (id and secret) and deletes its associated project44 app user (with username \"app-{client_id}@client-applications.project44.com\").\n<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteApplication",
        "parameters": [
          {
            "name": "clientId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    },
    "/api/v4/oauth2/client-applications/{clientId}/new-secret": {
      "post": {
        "tags": [
          "OAuth 2.0: Client Applications"
        ],
        "summary": "Generate a new client secret.",
        "description": "In case you have forgotten your application's client secret, or you wish to rotate it, generate a new one. Doing so invalidates the former client secret for the application, but does not invalidate any active access tokens you may have outstanding. Note you must record the client secret returned here securely as it cannot be retrieved again.\n<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "generateNewSecret",
        "parameters": [
          {
            "name": "clientId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClientApplication"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    },
    "/api/v4/oauth2/token": {
      "post": {
        "tags": [
          "OAuth 2.0: Token Generation"
        ],
        "summary": "Grant access token.",
        "description": "Authenticate with your client application's credentials (id and secret) to generate a new project44 access token. The resulting access token can be used as a bearer token to access your project44 account and data via project44's other APIs, while acting as that client application.\n\nYou may authenticate your client application either by passing the id and secret via HTTP Basic Authentication (via the \"Authorization\" HTTP header) or via the client_id and client_secret fields in the POST request body with no \"Authorization\" header included. You may not use both approaches to authenticate the same request.\n\nThe POST request body must contain the request fields as URL-encoded parameters (a URL-encoded form) and must have the \"Content-Type\" HTTP header set to \"application/x-www-form-urlencoded\".\n<h4><b>Required Fields</h4></b>\n<ul><li> client_id </li><li> client_secret </li><li> grant_type </li></ul>",
        "operationId": "grantTokenOAuth2",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "client_id": {
                    "type": "string",
                    "description": "The id of the client application, generated and assigned by project44 via the OAuth 2.0 client applications APIs."
                  },
                  "client_secret": {
                    "type": "string",
                    "description": "The secret part of the client application's credentials, generated and assigned by project44 via the OAuth 2.0 client applications APIs."
                  },
                  "grant_type": {
                    "type": "string",
                    "description": "The OAuth 2.0 authorization grant type, or flow, to be used by the client application. project44 supports only the \"client_credentials\" grant type and does not currently support grant types involving end user consent.",
                    "enum": [
                      "client_credentials"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuth2Token"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuth2Error"
                }
              }
            }
          },
          "401": {
            "description": "Invalid or missing credentials",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuth2Error"
                }
              }
            }
          },
          "403": {
            "description": "User not authorized to perform this operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuth2Error"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    },
    "/api/v4/ocean/shipments": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> equipmentIdentifier.type </li><li> equipmentIdentifier.value </li><li> carrierSCACCode </li></ul>",
        "operationId": "createOceanShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OceanShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/OceanShipment"
              }
            }
          },
          "description": "oceanShipment",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OceanShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/OceanShipmentConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a tracked ocean shipment from a container id or vessel id.",
        "tags": [
          "Ocean: Tracking"
        ]
      }
    },
    "/api/v4/ocean/shipments/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteOceanShipment",
        "parameters": [
          {
            "description": "The project44-generated shipmentId or oceanLegId associated with this shipment.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete shipment by project44 id.",
        "tags": [
          "Ocean: Tracking"
        ]
      }
    },
    "/api/v4/ocean/shipments/{id}/statuses": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getOceanShipmentStatuses",
        "parameters": [
          {
            "description": "The project44-generated shipmentId or oceanLegId associated with this shipment.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Determines whether the custom shipment attributes should be included in the response.",
            "in": "query",
            "name": "includeCustomAttributes",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "If this value is set to true, the response payload will contain a public link to view the shipment in the VOC",
            "in": "query",
            "name": "includeMapUrl",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Determines whether the history of the container's position over water should be included in the response.",
            "in": "query",
            "name": "includePositionData",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OceanTrackedShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/OceanTrackedShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get shipment statuses by project44 id.",
        "tags": [
          "Ocean: Tracking"
        ]
      }
    },
    "/api/v4/parcel/shipments": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li> shipmentStops(Optional):</li><ul><li><b>  location</b>(Required if stop is provided):</li><ul><li> <b>address</b>(Required if stop is provided)</li></ul></ul></ul>",
        "operationId": "createParcelShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ParcelShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/ParcelShipment"
              }
            }
          },
          "description": "parcelShipment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Initialize parcel shipment for tracking.",
        "tags": [
          "Parcel: Tracking"
        ]
      }
    },
    "/api/v4/parcel/shipments/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteParcelShipment",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentDeleteConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentDeleteConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete an existing parcel shipment using the unique system id.",
        "tags": [
          "Parcel: Tracking"
        ]
      }
    },
    "/api/v4/parcel/shipments/{id}/statuses": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getParcelShipmentStatusById",
        "parameters": [
          {
            "description": "id",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          },
          {
            "description": "includeStatusHistory",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the status of a parcel shipment using the unique system id.",
        "tags": [
          "Parcel: Tracking"
        ]
      }
    },
    "/api/v4/parcel/webhook/endpoint": {
      "delete": {
        "operationId": "deleteParcelEndpoint",
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete webhook endpoint - if one is defined.",
        "tags": [
          "Parcel: Webhook"
        ]
      },
      "get": {
        "operationId": "getParcelEndpoint",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelWebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelWebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the webhook URL where shipment tracking updates are posted.",
        "tags": [
          "Parcel: Webhook"
        ]
      },
      "put": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> url </li></ul>",
        "operationId": "createParcelEndpoint",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ParcelWebhookEndpoint"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/ParcelWebhookEndpoint"
              }
            }
          },
          "description": "pushEndpoint",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelWebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ParcelWebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Add or update webhook where shipment tracking updates are posted.",
        "tags": [
          "Parcel: Webhook"
        ]
      }
    },
    "/api/v4/rail/shipments/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteRailShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being queried.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete a shipment by system id.",
        "tags": [
          "Rail: Tracking"
        ]
      }
    },
    "/api/v4/rail/shipments/{id}/statuses": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getRailShipmentStatusById",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being queried.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether shipment status history ('statusUpdates') should be included in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get a shipment status by system id.",
        "tags": [
          "Rail: Tracking"
        ]
      }
    },
    "/api/v4/rail/shipments/statuses": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getRailShipmentStatus",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Whether shipment status history ('statusUpdates') should be included in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "description": "The type of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.type",
            "schema": {
              "enum": [
                "BILL_OF_LADING",
                "WAYBILL"
              ],
              "type": "string"
            }
          },
          {
            "description": "The value of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get a shipment status by shipment identifier.",
        "tags": [
          "Rail: Tracking"
        ]
      }
    },
    "/api/v4/shipmentattributedefinitions": {
      "get": {
        "operationId": "findShipmentAttributeDefinitions",
        "responses": {
          "200": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentAttributeDefinitionCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get all shipment attributes",
        "tags": [
          "Shipment Attributes"
        ]
      },
      "post": {
        "description": "The name for an attribute. Must be unique.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> name </li></ul>",
        "operationId": "createShipmentAttributeDefinition",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentAttributeDefinition"
              }
            }
          },
          "description": "attributeDefinition",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentAttributeDefinitionConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a predefined attribute. You must be a organization admin to perform this operation.",
        "tags": [
          "Shipment Attributes"
        ]
      }
    },
    "/api/v4/shipments/{masterShipmentId}/loads": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> masterShipmentId </li></ul>",
        "operationId": "getShipmentLoads",
        "parameters": [
          {
            "description": "The masterShipmentId of the shipment for which you wish to query the associated loads.",
            "in": "path",
            "name": "masterShipmentId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page number valid range: [1, 100]",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 1,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page size valid range: [1, 1000]",
            "in": "query",
            "name": "size",
            "schema": {
              "default": 100,
              "format": "int32",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LoadPage"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LoadPage"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get loads by masterShipmentId.",
        "tags": [
          "Shipment: Loads"
        ]
      }
    },
    "/api/v4/shipments/{shipmentId}/attributes": {
      "get": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> shipmentId </li></ul>",
        "operationId": "getShipmentTenantAttributes",
        "parameters": [
          {
            "description": "shipmentId",
            "in": "path",
            "name": "shipmentId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ShipmentTenantAttribute"
                  },
                  "type": "array"
                }
              },
              "application/xml": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ShipmentTenantAttribute"
                  },
                  "type": "array"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Fetch the tenant shipment attributes for a shipment.",
        "tags": [
          "Shipment: Tracking"
        ]
      }
    },
    "/api/v4/shipments/{shipmentId}/eventhistory": {
      "get": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Fetch the event history for a shipment.",
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> shipmentId </li></ul>",
        "operationId": "getShipmentEventHistory",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "includeRouteInfo",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentEventHistory"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "93627180-3d6a-4e0a-a161-d23ef1284611"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "57cf570f-d2fa-44aa-98de-3eabfa73d7d2"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/api/v4/shipments/{shipmentId}/positionhistory": {
      "get": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Fetch the position history for a shipment.",
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> shipmentId </li></ul>",
        "operationId": "getShipmentPositionHistory",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "includeRouteInfo",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentPositionHistory"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "3e6dfa26-9181-43af-9df2-b8ee1194487e"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "63eaadbb-e6a1-4af2-a2f3-29b3cfbb448f"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/api/v4/shipments/{shipmentId}/tracking": {
      "get": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Fetch the shipment information including the stops and route segments.",
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> shipmentId </li></ul>",
        "operationId": "gettrackedshipment",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrackedShipment"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "93c7ea1e-0188-4554-8d00-b779789f20d0"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "c72cb041-1503-4b64-87ee-5122fabcdff6"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "delete": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Delete shipment route from project44 to stop tracking.",
        "description": "Stop the shipment from tracking in project44 and delete record in the UI<br>\nNote: attempting to delete shipments that have been shared to you will result in a 404.",
        "operationId": "deleteshipment",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "92a4ff10-4bf5-448d-b1c8-9217c35a6865"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "b2da97cf-c191-41fb-9607-0f8478feffa2"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/api/v4/shipments/{shipmentId}/tracking/history": {
      "get": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Get full tracking history for a shipment.",
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> shipmentId </li></ul>",
        "operationId": "getshipmenttrackinghistory",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrackedShipmentHistory"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "59a332e8-04ba-48dc-83cd-78b192916f0e"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "25a7ecf2-47e0-45c6-b6bb-7de686bbf105"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/api/v4/shipments/pronumbers/query": {
      "get": {
        "operationId": "getProNumberBlock",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ProNumberBlock"
                  },
                  "type": "array"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get all ProNumber blocks.",
        "tags": [
          "LTL: Dispatch"
        ]
      },
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul></ul>",
        "operationId": "generateProNumber",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProNumberQuery"
              }
            }
          },
          "description": "proNumberQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProNumberIdentifier"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Generate a ProNumber for specific vendor.",
        "tags": [
          "LTL: Dispatch"
        ]
      },
      "put": {
        "operationId": "updateProNumber",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProNumberBlockVendorId"
              }
            }
          },
          "description": "proNumberBlockVendor",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update a ProNumber for specific vendor.",
        "tags": [
          "LTL: Dispatch"
        ]
      }
    },
    "/api/v4/shipments/tracking": {
      "put": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Initialize a shipment for tracking, or replace data for an existing shipment.",
        "description": "If the shipment does not exist, this will create a new shipment. \n\nIf the shipment is already being tracked (and the corresponding id field is provided), this operation will <b>fully replace</b> user provided data.Note: This modifies only data that the <b>user has provided</b>. \n\nIn addition, if a change occurs through this endpoint that makes a shipment no longer trackable via some source (AIR, OCEAN, RAIL, etc.) then previously received data from that source will be removed.For example, if a user creates a shipment via an AIR identifier (AIR_WAYBILL) and subsequently uses this endpoint to update the same shipment, replacing the AIR identifier with an OCEAN identifier, then any AIR data is expected to be removed from the shipment, as it is no longer tracking via AIR. \n\n<h4><b>Important Notes:</b></h4><ul><li>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL - an additional, valid CARRIER_SCAC identifier is mandatory for HOUSE_AIR_WAYBILL tracking</li><li>CARRIER_SCAC</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO_NUMBER</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul></ul></li></ul><h4><b>Required Fields</h4></b>\n<ul><li><b>  identifiers: </b> (at least one) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "describeShipmentUpsert",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackedShipmentWithEvents"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DescribeShipmentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "d0b67599-5ff7-4b78-8124-615bf951b314"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "91e093cd-aa47-4262-85eb-9234d61a9433"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 409,
                  "httpMessage": "Conflict",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "e44ed1e2-fa73-42de-aa41-4eff80dd9024"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "post": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Initialize a shipment for tracking, or append data to an existing shipment.",
        "description": "If the shipment does not exist, this will create a new shipment. \n\nIf the shipment is already being tracked (and the corresponding id field is provided), this operation is <b>add only</b> for the provided fields. \n\nNote: This operation only modifies data that the <b>user has provided</b>.\n\n<h4><b>Important Notes:</b></h4><ul><li>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL - an additional, valid CARRIER_SCAC identifier is mandatory for HOUSE_AIR_WAYBILL tracking</li><li>CARRIER_SCAC</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul></li></ul><h4><b>Required Fields</h4></b>\n<ul><li><b>  identifiers: </b> (at least one) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "postshipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackedShipmentWithEvents"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DescribeShipmentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "06c2ff2e-8193-435e-94e3-dfaacde4f07c"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 404,
                  "httpMessage": "Not Found",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "4cdf2be2-6e51-4b09-950d-0231e6971f52"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 409,
                  "httpMessage": "Conflict",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "25059e5d-7145-4fba-b073-41344096c853"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/api/v4/stoplocations": {
      "get": {
        "description": "Paginated with default page size of 10. The offset and pageSize query parameters modify this behavior, allowing you to retrieve all of your locations one page at a time.",
        "operationId": "listStopLocations",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "The offset of the first requested location within the total list of locations.",
            "in": "query",
            "name": "offset",
            "schema": {
              "default": 0,
              "format": "int64",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The maximum number of locations to return.",
            "in": "query",
            "name": "pageSize",
            "schema": {
              "default": 10,
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocationList"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocationList"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "List all stop locations used by your organization.",
        "tags": [
          "Stop Location Management"
        ]
      },
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\nTo create a valid stop location, you must supply a <b>name</b> plus one of <ul><li>A valid <b>STREET ADDRESS</b>. This is an address that includes all of:<ul><li><b>addressLines</b></li><li><b>city</b></li><li><b>state</b> and/or <b>postalCode</b></li><li><b>country</b></li></ul></li><li>A pair of valid <b>COORDINATES</b> along with an address that includes <b>COUNTRY</b></li><ul>",
        "operationId": "addStopLocation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StopLocation"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/StopLocation"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Submit a new shipment location.",
        "tags": [
          "Stop Location Management"
        ]
      }
    },
    "/api/v4/stoplocations/{id}": {
      "get": {
        "description": "This retrieves only the most recently saved version of the location.",
        "operationId": "getLatestVersion",
        "parameters": [
          {
            "description": "Id of the stop location to retrieve (required)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve latest version of a shipment location by id.",
        "tags": [
          "Stop Location Management"
        ]
      },
      "put": {
        "description": "Saves the location and increments its version number.",
        "operationId": "updateStopLocation",
        "parameters": [
          {
            "description": "Id of the stop location to retrieve (required)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StopLocation"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/StopLocation"
              }
            }
          },
          "description": "location",
          "required": true
        },
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update an existing shipment location of a specified id.",
        "tags": [
          "Stop Location Management"
        ]
      }
    },
    "/api/v4/stoplocations/{id}/versions": {
      "get": {
        "description": "This retrieves all of the versions of the location that have ever been saved. The versions can be distinguished by their version number. The version number starts at zero when the location is created and is incremented by one every time the location is saved.",
        "operationId": "getAllStopLocationVersions",
        "parameters": [
          {
            "description": "Id of the stop location to retrieve (required)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocationList"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocationList"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve all versions of a shipment location by id.",
        "tags": [
          "Stop Location Management"
        ]
      }
    },
    "/api/v4/stoplocations/{id}/versions/{version}": {
      "get": {
        "description": "This retrieves only the specified version of the location.",
        "operationId": "getSpecificStopLocationVersion",
        "parameters": [
          {
            "description": "Id of the stop location to retrieve (required)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "Version of the stop location to retrieve (required)",
            "in": "path",
            "name": "version",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/StopLocation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve a specific version of a shipment location by id and version number.",
        "tags": [
          "Stop Location Management"
        ]
      }
    },
    "/api/v4/tl/assets": {
      "get": {
        "description": "This endpoint will return all assets for the carrier that are known to project44. <h4><b>Required Fields</b></h4>\n<ul><li> capacityProviderIdentifierValue </li><li> capacityProviderIdentifierType </li></ul>",
        "operationId": "getAssets",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "The type of identifier provided.",
            "in": "query",
            "name": "capacityProviderIdentifierType",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The identifier of the capacity provider for which assets are requested",
            "in": "query",
            "name": "capacityProviderIdentifierValue",
            "schema": {
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Determines the range of results that are returned. Minimum: 1, Maximum: 1000, Default: 1",
            "in": "query",
            "name": "page",
            "schema": {
              "default": 1,
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "The page size, or maximum number of results which may be returned at once. Minimum: 1, Maximum: 1000, Default: 100",
            "in": "query",
            "name": "size",
            "schema": {
              "default": 100,
              "format": "int32",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadAssetCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get list of assets for a given carrier",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/available-vehicles/query": {
      "post": {
        "description": "Use this POST call to get ETA of all vehicles that are terminating their route within the radius. Search can be enhanced with the type of truck, radius size from the given location and a termination time window.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b> timeRange: </b></li><ul><li><b> startDateTime </b></li></ul><li><b> location: </b></li><ul><li><b> address: </b>(if no geoCoordinates provided)</li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico and Canada) </li></ul><li><b> geoCoordinates </b>(if no address provided)</li><ul><li> latitude </li><li> longitude </li></ul></ul></ul>",
        "operationId": "availableVehiclesQuery",
        "parameters": [
          {
            "allowEmptyValue": false,
            "description": "Page number valid range: [1, 1000]",
            "in": "query",
            "name": "page",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Page size valid range: [1, 1000]",
            "in": "query",
            "name": "size",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Sortable Fields [distance, carrierContact, estimatedArrivalDateTime, truckType]",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AvailableVehiclesQuery"
              }
            }
          },
          "description": "availableVehiclesQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableVehiclesPage"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get a list of available vehicles within the radius.",
        "tags": [
          "TL: Available Vehicles"
        ]
      }
    },
    "/api/v4/tl/connected-capacity/carriers/search": {
      "post": {
        "description": "Returns tracking statistics for carriers across all lanes served by that carrier",
        "operationId": "getCarrierPerformance",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierPerformanceQuery"
              }
            }
          },
          "description": "query",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierPerformanceCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Search for carrier performance",
        "tags": [
          "TL: Connected Capacity"
        ]
      }
    },
    "/api/v4/tl/connected-capacity/lanes/search": {
      "post": {
        "description": "Returns tracking statistics for carriers on specific lanes (origin/destination pairs) served by that carrier",
        "operationId": "getCarrierLanePerformance",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierLanePerformanceQuery"
              }
            }
          },
          "description": "query",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarrierLanePerformanceCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Search for carrier performance on specific lane or lanes",
        "tags": [
          "TL: Connected Capacity"
        ]
      }
    },
    "/api/v4/tl/equipment/validate": {
      "get": {
        "description": "Use this endpoint to test an equipment identifier to see if it is a valid equipment identifier for the given carrier that may be used for tracking. If the carrier's tracking vendor does not support validating equipment identifiers without initiating tracking, then the endpoint will always report that the identifier is valid. \n\n<table> <thead> <tr> <th>Equipment ID Type</th> <th><code>valid</code></th> <th><code>exists</code></th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td><code>EMERSON_DEVICE_ID</code>, <code>SENSITECH_DEVICE_ID</code>, <code>TIVE_DEVICE_ID</code>, <code>VEHICLE_ID</code></td> <td> <p><strong>True</strong>, if the equipment exists and is considered as active equipment by project44.</p> <p>This equipment is owned by the capacity provider and sent in the query params.</p> <p>Validity depends on the type of vendor. </p> </td> <td> <p><strong>True</strong>, if the equipment exists in the project44 system</p> <p>This equipment is owned by the capacity provider and passed as an argument to the endpoint (see <code>capacityProviderIdentifier.value</code>).</p> </td> <td>The capacity provider identifier passed as an argument to the endpoint must be the owner of the equipment.</td> </tr> <tr> <td><code>LICENSE_PLATE</code></td> <td><strong>True</strong>, if the asset can be used for tracking the shipment by the requester.</td> <td><strong>True</strong>, if the license plate exists in the project44 system.</td> <td>capacity provider identifier should be set to one of identifiers of requesting organisation</td> </tr> <tr> <td><code>MOBILE_PHONE_NUMBER</code></td> <td> <p><strong>True</strong>, if there is a driver who signed up with the given phone number <strong>OR</strong> if there is no driver who signed up with the given phone number but the phone number can be used to create a shipment. (see <code>exists</code> field).</p> </td> <td> <p><strong>True</strong>, if the mobile phone was used in the past to create a shipment.</p> <p><strong>False</strong>, if there is no driver with such phone number in project44 network.</p> </td> <td></td> </tr> </tbody> </table>",
        "operationId": "validateEquipment",
        "parameters": [
          {
            "description": "Capacity provider identifier type.",
            "in": "query",
            "name": "capacityProviderIdentifier.type",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "description": "Capacity provider identifier value.",
            "in": "query",
            "name": "capacityProviderIdentifier.value",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Optional field indicating whether equipment identifier should be deleted.",
            "in": "query",
            "name": "equipmentIdentifier.shouldDelete",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "The type of the equipment identifier.",
            "in": "query",
            "name": "equipmentIdentifier.type",
            "schema": {
              "enum": [
                "MOBILE_PHONE_NUMBER",
                "VEHICLE_ID",
                "LICENSE_PLATE",
                "SENSITECH_DEVICE_ID",
                "EMERSON_DEVICE_ID",
                "TIVE_DEVICE_ID",
                "CONTAINER_ID"
              ],
              "type": "string"
            }
          },
          {
            "description": "The value of the equipment identifier. Cell phone numbers will be obfuscated in project44 responses for privacy reasons.",
            "in": "query",
            "name": "equipmentIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadEquipmentValidationResult"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadEquipmentValidationResult"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Validate equipment identifiers",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments": {
      "delete": {
        "description": "Use this endpoint to delete an existing truckload shipment with a given shipment identifier.<h4><b>Required Fields</h4></b>\n<ul><li> carrierIdentifier.type </li><li> carrierIdentifier.value </li><li> shipmentIdentifier.type </li><li> shipmentIdentifier.value </li></ul>",
        "operationId": "deleteTruckloadShipmentByShipmentIdentifier",
        "parameters": [
          {
            "description": "Capacity provider identifier type.",
            "in": "query",
            "name": "carrierIdentifier.type",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "description": "Capacity provider identifier value.",
            "in": "query",
            "name": "carrierIdentifier.value",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The type of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.type",
            "schema": {
              "enum": [
                "BILL_OF_LADING",
                "ORDER"
              ],
              "type": "string"
            }
          },
          {
            "description": "The value of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete truckload shipment by shipment identifier",
        "tags": [
          "TL: Tracking"
        ]
      },
      "post": {
        "description": "Use this POST call to start a tracking job, initializing Truckload Tracking. Note that If the shipment is initialized by using GeoCoordinates instead of an address, it may be possible that a street address will not be returned in the response.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentStops: </b> (at least two) </li><ul><li> stopNumber </li><li><b>  appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul><li><b>  location: </b></li><ul><li><b>  address: </b> (if no geoCoordinates provided) </li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico, and Canada) </li></ul><li><b>  contact: </b></li><ul><li> companyName </li></ul></ul><li><b>  geoCoordinates: </b> (if no address provided) </li></li><ul><li> latitude </li><li> longitude </li></ul></ul><li><b>  capacityProviderAccountGroup: </b> (by a few capacity providers) </li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  equipmentIdentifiers: </b> (by most capacity providers) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "createTruckloadShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "start tracking a truckload shipment",
        "tags": [
          "TL: Tracking"
        ]
      },
      "put": {
        "description": "Use this endpoint to update a truckload shipment with a given shipment identifier.<p><b>Example:</b> You can update location fields or appointment windows to reflect changes with this endpoint.</p>Note that tracking information updates are currently not supported. This includes shipmentIdentifiers, capacityProviderAccountGroup, and apiConfiguration changes.* It is suggested to first get the current shipment object from the GET shipment endpoint, make the desired modifications, and then PUT the modified shipment to this endpoint. After the modified shipment is successfully submitted, the updated stops, attributes, shipping details etc. will be applied and used in tracking from then on. If a shipment PUT request comes in with only GeoCoordinates, it is possible that a street address will not be returned in the response. \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentStops: </b> (at least two) </li><ul><li> stopNumber </li><li><b>  appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul><li><b>  location: </b></li><ul><li><b>  address: </b> (if no geoCoordinates provided) </li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico, and Canada) </li></ul><li><b>  contact: </b></li><ul><li> companyName </li></ul></ul><li><b>  geoCoordinates: </b> (if no address provided) </li></li><ul><li> latitude </li><li> longitude </li></ul></ul><li><b>  capacityProviderAccountGroup: </b> (by a few capacity providers) </li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  equipmentIdentifiers: </b> (by most capacity providers) </li><ul><li> type </li><li> value </li><li> (Optional) shouldDelete </li></ul></ul>",
        "operationId": "updateTruckloadShipmentByShipmentIdentifier",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update a truckload shipment by shipment identifier",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/{id}": {
      "delete": {
        "description": "Use this endpoint to delete an existing truckload shipment with a given unique system id.<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteTruckloadShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being deleted.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete truckload shipment by unique system id",
        "tags": [
          "TL: Tracking"
        ]
      },
      "get": {
        "description": "Use this endpoint to return a truckload shipment with a given unique system id.<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getTruckloadShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being queried.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipment"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipment"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get Truckload shipment by unique system id",
        "tags": [
          "TL: Tracking"
        ]
      },
      "put": {
        "description": "Use this endpoint to update a truckload shipment. <p><b>Example:</b> You can update location fields or appointment windows to reflect changes with this endpoint.</p>Note that tracking information updates are currently not supported. This includes shipmentIdentifiers, capacityProviderAccountGroup, and apiConfiguration changes.* It is suggested to first get the current shipment object from the GET shipment endpoint, make the desired modifications, and then PUT the modified shipment to this endpoint. After the modified shipment is successfully submitted, the updated stops, attributes, shipping details etc. will be applied and used in tracking from then on. If a shipment PUT request comes in with only GeoCoordinates, it is possible that a street address will not be returned in the response. \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b>  shipmentStops: </b> (at least two) </li><ul><li> stopNumber </li><li><b>  appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul><li><b>  location: </b></li><ul><li><b>  address: </b> (if no geoCoordinates provided) </li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico, and Canada) </li></ul><li><b>  contact: </b></li><ul><li> companyName </li></ul></ul><li><b>  geoCoordinates: </b> (if no address provided) </li></li><ul><li> latitude </li><li> longitude </li></ul></ul><li><b>  capacityProviderAccountGroup: </b> (by a few capacity providers) </li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  equipmentIdentifiers: </b> (by most capacity providers) </li><ul><li> type </li><li> value </li></ul></ul>",
        "operationId": "updateTruckloadShipment",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being updated.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Update a truckload shipment",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/{id}/actions": {
      "post": {
        "description": "Use this endpoint to create an action for an existing truckload shipment identified by a given unique system id.<h4><b>Required Fields</h4></b>\n<ul><li> id </li><li> code </li></ul>",
        "operationId": "createTruckloadShipmentAction",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment to which this action applies.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipmentAction"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/TruckloadShipmentAction"
              }
            }
          },
          "description": "shipmentAction",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentActionConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentActionConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create action for existing truckload shipment by unique system id",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/{id}/equipmentapprovals/requests": {
      "post": {
        "description": "Use this endpoint to request an ad hoc equipment approval from a given tracking provider.Note that this is only supported for the app-less tracking method once every 24h.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "requestTruckloadEquipmentApproval",
        "parameters": [
          {
            "description": "The project44-generated id for the shipment.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "content": {},
            "description": "No Content"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Request ad hoc equipment approval from the tracking provider",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/{id}/statuses": {
      "get": {
        "description": "Use this endpoint to return the status of a truckload shipment with a given unique system id.<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "getTruckloadShipmentStatusById",
        "parameters": [
          {
            "description": "The project44-generated id of the shipment being queried.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether a publicly accessible URL to the shipment details page should be included in the response.",
            "in": "query",
            "name": "includeMapUrl",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether shipment sensor history ('sensorHistory') should be included in the response.",
            "in": "query",
            "name": "includeSensorHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether shipment status history ('statusUpdates') should be included in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get status of truckload shipment by unique system id",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/statuses": {
      "get": {
        "description": "Use this endpoint to return a truckload shipment with a given shipment identifier.<h4><b>Required Fields</h4></b>\n<ul><li> carrierIdentifier.type </li><li> carrierIdentifier.value </li><li> shipmentIdentifier.type </li><li> shipmentIdentifier.value </li></ul>",
        "operationId": "getTruckloadShipmentStatus",
        "parameters": [
          {
            "description": "Capacity provider identifier type.",
            "in": "query",
            "name": "carrierIdentifier.type",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "description": "Capacity provider identifier value.",
            "in": "query",
            "name": "carrierIdentifier.value",
            "schema": {
              "type": "string"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether a publicly accessible URL to the shipment details page should be included in the response.",
            "in": "query",
            "name": "includeMapUrl",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether shipment sensor history ('sensorHistory') should be included in the response.",
            "in": "query",
            "name": "includeSensorHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "allowEmptyValue": false,
            "description": "Whether shipment status history ('statusUpdates') should be included in the response.",
            "in": "query",
            "name": "includeStatusHistory",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "description": "The type of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.type",
            "schema": {
              "enum": [
                "BILL_OF_LADING",
                "ORDER"
              ],
              "type": "string"
            }
          },
          {
            "description": "The value of the shipment identifier.",
            "in": "query",
            "name": "shipmentIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentStatus"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentStatus"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get status of a truckload shipment by shipment identifier",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/shipments/trackingmethods": {
      "get": {
        "description": "Use this endpoint to return available shipment tracking methods for a given carrier.<h4><b>Required Fields</h4></b>\n<ul><li> carrierIdentifier.type </li><li> carrierIdentifier.value </li></ul>",
        "operationId": "getTruckloadTrackingMethods",
        "parameters": [
          {
            "description": "Capacity provider identifier type.",
            "in": "query",
            "name": "carrierIdentifier.type",
            "schema": {
              "enum": [
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU",
                "SYSTEM",
                "P44_GLOBAL",
                "VAT"
              ],
              "type": "string"
            }
          },
          {
            "description": "Capacity provider identifier value.",
            "in": "query",
            "name": "carrierIdentifier.value",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentTrackingMethods"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/TruckloadShipmentTrackingMethods"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get available shipment tracking methods for a carrier",
        "tags": [
          "TL: Tracking"
        ]
      }
    },
    "/api/v4/tl/webhooks/endpoints": {
      "get": {
        "operationId": "getTLEndpoints",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/WebhookEndpoint"
                  },
                  "type": "array"
                }
              },
              "application/xml": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/WebhookEndpoint"
                  },
                  "type": "array"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Get the webhook URLs where shipment tracking updates are posted.",
        "tags": [
          "TL: Webhook"
        ]
      },
      "put": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id (for updates only) </li><li> version (for updates only) </li><li> configName </li><li> url </li></ul>",
        "operationId": "createTLEndpoint",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpoint"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpoint"
              }
            }
          },
          "description": "pushEndpoint",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Add or update webhook where shipment tracking updates are posted.",
        "tags": [
          "TL: Webhook"
        ]
      }
    },
    "/api/v4/tl/webhooks/endpoints/{id}": {
      "delete": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li> id </li></ul>",
        "operationId": "deleteTLEndpoint",
        "parameters": [
          {
            "description": "The project44-generated id of the endpoint being deleted.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete a given webhook endpoint - if one is defined.",
        "tags": [
          "TL: Webhook"
        ]
      }
    },
    "/api/v4/vltl/dispatchedshipments": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  capacityProviderAccountGroup: </b></li><ul><li><b>  accounts: </b></li><ul><li> code </li></ul></ul><li><b>  originLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default origin contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b>  destinationLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default destination contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul></ul><li><b>  requesterLocation: </b></li><ul><li><b>  address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b>  contact: </b> (if no default requester contact is set for provided capacity provider account)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li><li> email </li></ul></ul><li><b>  lineItems: </b></li><ul><li> totalWeight </li><li><b>  packageDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul><li> freightClass </li><li><b>  hazmatDetail: </b> (if line item contains hazardous materials)</li><ul><li> identificationNumber </li><li> properShippingName </li><li> hazardClass </li><li> packingGroup </li></ul></ul><li><b>  pickupWindow: </b></li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li><b>  deliveryWindow: </b> (by some capacity providers if requesting guaranteed or expedited services)</li><ul><li> date </li><li> startTime </li><li> endTime </li></ul><li> carrierCode (if capacity provider supports multiple SCACs) </li><li><b>  emergencyContact: </b> (if shipment contains hazardous materials)</li><ul><li> companyName </li><li> contactName </li><li> phoneNumber </li></ul><li> capacityProviderQuoteNumber </li></ul>",
        "operationId": "createVolumeLtlDispatchedShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LtlDispatchedShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/LtlDispatchedShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LtlDispatchedShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LtlDispatchedShipmentConfirmation"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create a volume LTL shipment.",
        "tags": [
          "VLTL: Dispatch"
        ]
      }
    },
    "/api/v4/vltl/quotes/rates/query": {
      "post": {
        "description": "<h4><b>Required Fields</h4></b>\n<ul><li><b>  originAddress: </b></li><ul><li> postalCode </li></ul><li><b>  destinationAddress: </b></li><ul><li> postalCode </li></ul><li><b>  lineItems: </b></li><ul><li> totalWeight </li><li><b>  packageDimensions: </b></li><ul><li> length </li><li> width </li><li> height </li></ul></ul><li> totalLinearFeet (if linear feet calculator is disabled) </li></ul>",
        "operationId": "queryVolumeLtlRateQuotes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RateQuoteQuery"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/RateQuoteQuery"
              }
            }
          },
          "description": "rateQuoteQuery",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateQuoteCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/RateQuoteCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Query for volume LTL rate quotes.",
        "tags": [
          "VLTL: Quotes"
        ]
      }
    },
    "/api/v4/webhooks": {
      "get": {
        "description": "Retrieve all push configurations for a tenant and user.",
        "operationId": "getAllWebhookConfigurationsForUser",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointCollection"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointCollection"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve all push configurations.",
        "tags": [
          "Webhook"
        ]
      },
      "put": {
        "description": "Create or update a single push configuration. A maximum of 50 push configurations may be saved per tenant.",
        "operationId": "createOrUpdateWebhookConfiguration",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpoint"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpoint"
              }
            }
          },
          "description": "webhookEndpoint",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Create or update a push configuration.",
        "tags": [
          "Webhook"
        ]
      }
    },
    "/api/v4/webhooks/{webhookId}": {
      "delete": {
        "description": "Delete a push configuration.",
        "operationId": "deleteWebhookConfiguration",
        "parameters": [
          {
            "description": "webhookId",
            "in": "path",
            "name": "webhookId",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {},
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Delete a push configuration.",
        "tags": [
          "Webhook"
        ]
      },
      "get": {
        "description": "Retrieve a push configuration by id.",
        "operationId": "getWebhookConfigurationById",
        "parameters": [
          {
            "description": "webhookId",
            "in": "path",
            "name": "webhookId",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve a push configuration by id.",
        "tags": [
          "Webhook"
        ]
      }
    },
    "/api/v4/webhooks/name/{webhookName}": {
      "get": {
        "description": "Retrieve a push configuration by name.",
        "operationId": "getWebhookConfigurationByName",
        "parameters": [
          {
            "description": "webhookName",
            "in": "path",
            "name": "webhookName",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Retrieve a push configuration by name.",
        "tags": [
          "Webhook"
        ]
      }
    },
    "/services/appointments/v1/appointment/{appointmentId}/milestones": {
      "put": {
        "summary": "Update appointment milestones",
        "description": "Update milestones for a specific appointment",
        "tags": [
          "Milestones"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "appointmentId",
            "in": "path",
            "required": true,
            "description": "The ID of the appointment",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MilestonesSchema"
              },
              "example": {
                "milestones": [
                  {
                    "event": "ARRIVED",
                    "scheduledDateTime": "2024-01-15T10:00:00Z",
                    "actualDateTime": "2024-01-15T10:30:00Z"
                  },
                  {
                    "event": "CHECKED_IN",
                    "scheduledDateTime": "2024-01-15T10:05:00Z",
                    "actualDateTime": "2024-01-15T10:35:00Z"
                  },
                  {
                    "event": "START",
                    "scheduledDateTime": "2024-01-15T10:15:00Z",
                    "actualDateTime": "2024-01-15T10:45:00Z"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Milestones updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppointmentsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request - Invalid milestone data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Appointment not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "put_servicesappointmentsv1appointmentappointmentIdmilestones"
      }
    },
    "/services/appointments/v1/appointments": {
      "post": {
        "summary": "Book an appointment",
        "description": "Create a new appointment for a shipment",
        "tags": [
          "Appointments"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppointmentsFieldsSchema"
              },
              "example": {
                "slotStartDateTime": "2024-01-15T10:00:00Z",
                "slotEndDateTime": "2024-01-15T12:00:00Z",
                "identifiers": {
                  "shipmentReference": "SHIP123456",
                  "stopSequenceNumber": 1,
                  "siteCode": "SITE001"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Appointment booked successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppointmentsResponse"
                },
                "example": {
                  "status": "SUCCESS",
                  "appointment": {
                    "appointmentId": 12345,
                    "scheduleStartDateTime": "2024-01-15T10:00:00Z",
                    "scheduleEndDateTime": "2024-01-15T12:00:00Z",
                    "slotDurationInMinutes": 120
                  },
                  "location": {
                    "siteCode": "SITE001",
                    "siteName": "Main Distribution Center",
                    "identifier": [
                      "EXT001",
                      "EXT002"
                    ]
                  },
                  "yardShipment": {
                    "id": "shipment_123",
                    "carrier": "ABC Trucking",
                    "loadType": "live",
                    "serviceType": "delivery",
                    "status": "SCHEDULED",
                    "trailer": "TRL123456",
                    "vendor": "Vendor Corp",
                    "cabNo": "CAB789",
                    "units": 50,
                    "weight": 5000,
                    "pallets": 25,
                    "licensePlateNo": "ABC123",
                    "customer": "Customer Inc",
                    "reference1": "SHIP123456",
                    "reference2": "REF789",
                    "comment": "Handle with care",
                    "commodity": "Electronics",
                    "orderIds": [
                      "ORD001",
                      "ORD002"
                    ],
                    "loadInformation": [
                      {
                        "sku": "SKU123",
                        "productType": "Laptop",
                        "quantity": 25
                      }
                    ]
                  },
                  "milestones": [
                    {
                      "event": "ARRIVED",
                      "scheduledDateTime": "2024-01-15T10:00:00Z",
                      "actualDateTime": null
                    },
                    {
                      "event": "CHECKED_IN",
                      "scheduledDateTime": "2024-01-15T10:05:00Z",
                      "actualDateTime": null
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request - Invalid input data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Invalid or missing token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - Insufficient permissions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "post_servicesappointmentsv1appointments"
      },
      "get": {
        "summary": "Get appointment details for shipment",
        "description": "Retrieve appointment details based on query parameters",
        "tags": [
          "Appointments"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "shipmentReference",
            "in": "query",
            "description": "Shipment reference number",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "siteCode",
            "in": "query",
            "description": "Site code",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "Start date for appointment search",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "End date for appointment search",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Appointment details retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppointmentsResponse"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "get_servicesappointmentsv1appointments"
      }
    },
    "/services/appointments/v1/appointments/{appointmentId}": {
      "get": {
        "summary": "Get appointment by ID",
        "description": "Retrieve a specific appointment by its ID",
        "tags": [
          "Appointments"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "appointmentId",
            "in": "path",
            "required": true,
            "description": "The ID of the appointment",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Appointment retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppointmentsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Appointment not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "get_servicesappointmentsv1appointmentsappointmentId"
      },
      "put": {
        "summary": "Reschedule appointment",
        "description": "Update an existing appointment with new time slot",
        "tags": [
          "Appointments"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "appointmentId",
            "in": "path",
            "required": true,
            "description": "The ID of the appointment to reschedule",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppointmentsRescheduleFieldsSchema"
              },
              "example": {
                "slotStartDateTime": "2024-01-16T14:00:00Z",
                "slotEndDateTime": "2024-01-16T16:00:00Z",
                "identifiers": {
                  "shipmentReference": "SHIP123456",
                  "stopSequenceNumber": 1,
                  "siteCode": "SITE001"
                },
                "reasonCode": "RESCHEDULE"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Appointment rescheduled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppointmentsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Appointment not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "put_servicesappointmentsv1appointmentsappointmentId"
      },
      "delete": {
        "summary": "Cancel appointment",
        "description": "Cancel an existing appointment",
        "tags": [
          "Appointments"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "appointmentId",
            "in": "path",
            "required": true,
            "description": "The ID of the appointment to cancel",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "reasonCode",
            "in": "query",
            "required": true,
            "description": "Reason code for cancellation",
            "schema": {
              "type": "string"
            },
            "example": "CANCEL_WEATHER"
          }
        ],
        "responses": {
          "200": {
            "description": "Appointment cancelled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CancelAppointmentResponse"
                },
                "example": {
                  "status": "SUCCESS"
                }
              }
            }
          },
          "400": {
            "description": "Bad request - Invalid appointment ID or reason code",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Appointment not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "406": {
            "description": "Not acceptable - Missing required reason code",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Conflict - Unable to cancel appointment",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "delete_servicesappointmentsv1appointmentsappointmentId"
      }
    },
    "/services/appointments/v1/capacity": {
      "get": {
        "summary": "Get capacity information",
        "description": "Retrieve capacity information for a specific site and date",
        "tags": [
          "Capacity"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "siteCode",
            "in": "query",
            "description": "Site code to get capacity for",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SITE001"
          },
          {
            "name": "capacityDate",
            "in": "query",
            "description": "Date for capacity information (YYYY-MM-DD format)",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2024-01-15"
          }
        ],
        "responses": {
          "200": {
            "description": "Capacity information retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CapacityResponse"
                },
                "example": {
                  "siteCode": "SITE001",
                  "capacityDate": "2024-01-15",
                  "unplannedShipmentsCount": 2,
                  "totalSlots": 20,
                  "totalBookedSlots": 8,
                  "totalCapacity": 10,
                  "availableSlots": [
                    {
                      "section": "DOCK001",
                      "startDateTime": "2024-01-15T10:00:00-05:00",
                      "endDateTime": "2024-01-15T12:00:00-05:00"
                    },
                    {
                      "section": "DOCK002",
                      "startDateTime": "2024-01-15T14:00:00-05:00",
                      "endDateTime": "2024-01-15T16:00:00-05:00"
                    }
                  ],
                  "bookedSlots": [
                    {
                      "shipmentNumber": "SHIP123456",
                      "startDateTime": "2024-01-15T09:00:00-05:00",
                      "endDateTime": "2024-01-15T11:00:00-05:00"
                    },
                    {
                      "shipmentNumber": "SHIP789012",
                      "startDateTime": "2024-01-15T13:00:00-05:00",
                      "endDateTime": "2024-01-15T15:00:00-05:00"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request - Invalid input data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Site not found or no capacity data available",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "get_servicesappointmentsv1capacity"
      }
    },
    "/services/appointments/v1/reasoncodes": {
      "get": {
        "summary": "Get reason codes by site",
        "description": "Retrieve reason codes available for a specific site",
        "tags": [
          "Reason Codes"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "parameters": [
          {
            "name": "siteCode",
            "in": "query",
            "description": "Site code to get reason codes for",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SITE001"
          }
        ],
        "responses": {
          "200": {
            "description": "Reason codes retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReasonCodeListResponse"
                },
                "example": {
                  "status": "SUCCESS",
                  "reasonCodes": [
                    "CANCEL_WEATHER",
                    "CANCEL_DRIVER_UNAVAILABLE",
                    "CANCEL_EQUIPMENT_ISSUE",
                    "RESCHEDULE_CUSTOMER_REQUEST",
                    "RESCHEDULE_OPERATIONAL_DELAY"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request - Invalid query parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Site not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "get_servicesappointmentsv1reasoncodes"
      }
    },
    "/services/appointments/v1/sitecodes": {
      "get": {
        "summary": "Get site codes",
        "description": "Retrieve all active site codes for the organization",
        "tags": [
          "Site Codes"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "responses": {
          "200": {
            "description": "Site codes retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteCodeListResponse"
                },
                "example": {
                  "status": "SUCCESS",
                  "sites": [
                    {
                      "code": "SITE001",
                      "name": "Main Distribution Center",
                      "locationIdentifiers": [
                        "EXT001",
                        "EXT002"
                      ]
                    },
                    {
                      "code": "SITE002",
                      "name": "Secondary Warehouse",
                      "locationIdentifiers": [
                        "EXT003"
                      ]
                    },
                    {
                      "code": "SITE003",
                      "name": "Regional Hub",
                      "locationIdentifiers": []
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "get_servicesappointmentsv1sitecodes"
      }
    },
    "/services/appointments/v1/slots": {
      "post": {
        "summary": "Get available slots for shipment",
        "description": "Retrieve available time slots for a shipment",
        "tags": [
          "Slots"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SlotRequestSchema"
              },
              "example": {
                "appointmentWindow": {
                  "start_date_time": "2024-01-15T00:00:00Z",
                  "end_date_time": "2024-01-20T23:59:59Z"
                },
                "identifiers": {
                  "shipmentReference": "SHIP123456",
                  "siteCode": "SITE001",
                  "stopSequenceNumber": 1
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Available slots retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SlotsResponse"
                },
                "example": {
                  "status": "SUCCESS",
                  "results": [
                    {
                      "shipmentReference": "SHIP123456",
                      "siteCode": "SITE001",
                      "stopReferenceNumber": 1,
                      "slots": [
                        {
                          "startDateTime": "2024-01-15T10:00:00-05:00",
                          "endDateTime": "2024-01-15T12:00:00-05:00"
                        },
                        {
                          "startDateTime": "2024-01-15T14:00:00-05:00",
                          "endDateTime": "2024-01-15T16:00:00-05:00"
                        },
                        {
                          "startDateTime": "2024-01-16T09:00:00-05:00",
                          "endDateTime": "2024-01-16T11:00:00-05:00"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "No slots available",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "operationId": "post_servicesappointmentsv1slots"
      }
    },
    "/services/booking/v1/bookings": {
      "get": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Get Bookings",
        "description": "As either a carrier or a shipper, fetch a paginated batch selection of filtered bookings.",
        "operationId": "get_bookings_bookings_get",
        "parameters": [
          {
            "description": "The name of the custom booking attribute to search against.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The name of the custom booking attribute to search against."
            },
            "name": "attribute.name",
            "in": "query"
          },
          {
            "description": "The values of the custom booking attribute to search for; this filter is non-partial.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The values of the custom booking attribute to search for; this filter is non-partial."
            },
            "name": "attribute.values",
            "in": "query"
          },
          {
            "description": "List of booking statuses to filter against.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/BookingStatus"
              },
              "description": "List of booking statuses to filter against."
            },
            "name": "statuses",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "default": 1
            },
            "name": "pageNumber",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "maximum": 100,
              "type": "integer",
              "default": 10
            },
            "name": "pageSize",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookingPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "post": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Create Booking",
        "description": "As a shipper, create a booking request for an existing shipment to send to a Carrier.",
        "operationId": "create_booking_bookings_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUpdateBooking"
              },
              "examples": {
                "Air Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "IPSH"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "phoneNumber": "1223334445",
                        "mobilePhoneNumber": "1223334444",
                        "email": "j.hudson@carrier-company.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "fuelSurchargeRate": {
                      "currency": "USD",
                      "amount": 275
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2026-03-11T08:30:00+00:00",
                    "routeSegmentIds": [
                      "c1816420-f5a7-4321-89e3-3a8a4acab734"
                    ],
                    "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                    "shipmentDetails": [
                      {
                        "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                        "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            },
                            "items": [
                              {
                                "description": "Custom accessories",
                                "identifiers": [
                                  {
                                    "type": "SALES_ORDER",
                                    "value": "SO-1a2b3c"
                                  }
                                ],
                                "unitQuantity": 12,
                                "unitType": "BOX"
                              }
                            ]
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "phoneNumber": "1223334445",
                      "mobilePhoneNumber": "1223334444",
                      "email": "j.smith@shipper-company.com"
                    },
                    "shippingDetails": {
                      "parties": [
                        {
                          "partyType": "SHIPPER",
                          "contactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "400 Montgomery St",
                              "2nd Floor"
                            ],
                            "postalCode": "94104",
                            "city": "San Francisco",
                            "state": "CA",
                            "country": "US"
                          },
                          "vatNumber": "vat-123"
                        },
                        {
                          "partyType": "BOOKING_AGENT",
                          "contactInfo": {
                            "companyName": "Notify Party Company Name",
                            "givenName": "Henry",
                            "familyName": "Jacobsen",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "h.jacobsen@notify-company.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "222 W. Merchandise Mart Plaza",
                              "Suite 1744"
                            ],
                            "postalCode": "60654",
                            "city": "Chicago",
                            "state": "IL",
                            "country": "US"
                          },
                          "vatNumber": "vat-234"
                        }
                      ],
                      "serviceType": "PORT_TO_PORT",
                      "cargoMeasurements": {
                        "volume": {
                          "value": 480,
                          "unit": "CUBIC_FT"
                        },
                        "weight": {
                          "value": 2500,
                          "unit": "KG"
                        },
                        "dimensions": {
                          "length": 20,
                          "width": 6,
                          "height": 4,
                          "unit": "FT"
                        }
                      }
                    }
                  }
                },
                "Ocean Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "CODE"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "3101428c-705c-4ec0-967b-7975bd1d3edc"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "1f7c4d02-919e-4d75-a2cf-7641ee271d58",
                        "deliveryStopId": "5e5eed3f-ab19-4e59-931d-3768c0d2d9b8",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "parties": [
                        {
                          "partyType": "SHIPPER",
                          "contactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "400 Montgomery St",
                              "2nd Floor"
                            ],
                            "postalCode": "94104",
                            "city": "San Francisco",
                            "state": "CA",
                            "country": "US"
                          }
                        },
                        {
                          "partyType": "NOTIFY_PARTY",
                          "contactInfo": {
                            "companyName": "Notify Party Company Name",
                            "givenName": "Henry",
                            "familyName": "Jacobsen",
                            "email": "h.jacobsen@notify-company.project44.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "222 W. Merchandise Mart Plaza",
                              "Suite 1744"
                            ],
                            "postalCode": "60654",
                            "city": "Chicago",
                            "state": "IL",
                            "country": "US"
                          }
                        }
                      ],
                      "serviceType": "DOOR_TO_DOOR",
                      "bookingType": "FULL_CONTAINER_LOAD",
                      "incoterm": "DAP",
                      "containerCount": {
                        "reeferCount": {
                          "fortyFootContainerCount": 1
                        }
                      },
                      "accessorials": [
                        {
                          "code": "REFRIGERATED",
                          "details": {
                            "min": 32,
                            "max": 40,
                            "unit": "FAHRENHEIT"
                          }
                        }
                      ]
                    }
                  }
                },
                "Truckload Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "DOT_NUMBER",
                      "value": "01234567"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "fuelSurchargeRate": {
                      "currency": "USD",
                      "amount": 275
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "5a0498bb-fb7d-4805-90c9-da6acd246a73"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "911dcfe7-6980-4b28-a0d2-b8377ea88719",
                        "deliveryStopId": "8e076e12-ccf3-401d-b159-d308834a27af",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "loadPreference": "FULL",
                      "trailerType": "FLATBED",
                      "flatbedType": "DOUBLE_DROP"
                    }
                  }
                },
                "Multi Stop Truckload Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "JBHU"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "fuelSurchargeRate": {
                      "currency": "USD",
                      "amount": 275
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "1475b8af-d75a-4a0b-b2a8-5bcaf3a20a4f",
                      "8bbcb5c1-5fcd-436f-8e47-57dbbde3074c",
                      "0cd3fb01-afca-4788-8104-70ccbeab75c8"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "c3e64d20-65e1-4e39-b5a1-5d756ad92904",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 4,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      },
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "c444cd5a-14dd-414d-a603-9986671675f4",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 5,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      },
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "5dce247e-4b2f-4076-bc8a-693da1f6b496",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 13,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "loadPreference": "FULL",
                      "trailerType": "FLATBED",
                      "flatbedType": "DOUBLE_DROP"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/bookings/{bookingId}": {
      "get": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Get Booking",
        "description": "As either a carrier or a shipper, fetch a single booking.",
        "operationId": "get_booking_bookings__bookingId__get",
        "parameters": [
          {
            "description": "The project44-generated booking identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated booking identifier",
              "format": "uuid"
            },
            "name": "bookingId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "put": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Update Booking",
        "description": "As a shipper, update a booking request for an existing shipment to send to a Carrier.",
        "operationId": "update_booking_bookings__bookingId__put",
        "parameters": [
          {
            "description": "The project44-generated booking identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated booking identifier",
              "format": "uuid"
            },
            "name": "bookingId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUpdateBooking"
              },
              "examples": {
                "Air Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "IPSH"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "phoneNumber": "1223334445",
                        "mobilePhoneNumber": "1223334444",
                        "email": "j.hudson@carrier-company.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2026-03-11T08:30:00+00:00",
                    "routeSegmentIds": [
                      "c1816420-f5a7-4321-89e3-3a8a4acab734"
                    ],
                    "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                    "shipmentDetails": [
                      {
                        "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                        "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            },
                            "items": [
                              {
                                "description": "Custom accessories",
                                "identifiers": [
                                  {
                                    "type": "SALES_ORDER",
                                    "value": "SO-1a2b3c"
                                  }
                                ],
                                "unitQuantity": 12,
                                "unitType": "BOX"
                              }
                            ]
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "phoneNumber": "1223334445",
                      "mobilePhoneNumber": "1223334444",
                      "email": "j.smith@shipper-company.com"
                    },
                    "shippingDetails": {
                      "parties": [
                        {
                          "partyType": "SHIPPER",
                          "contactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "400 Montgomery St",
                              "2nd Floor"
                            ],
                            "postalCode": "94104",
                            "city": "San Francisco",
                            "state": "CA",
                            "country": "US"
                          },
                          "vatNumber": "vat-123"
                        },
                        {
                          "partyType": "BOOKING_AGENT",
                          "contactInfo": {
                            "companyName": "Notify Party Company Name",
                            "givenName": "Henry",
                            "familyName": "Jacobsen",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "h.jacobsen@notify-company.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "222 W. Merchandise Mart Plaza",
                              "Suite 1744"
                            ],
                            "postalCode": "60654",
                            "city": "Chicago",
                            "state": "IL",
                            "country": "US"
                          },
                          "vatNumber": "vat-234"
                        }
                      ],
                      "serviceType": "PORT_TO_PORT",
                      "cargoMeasurements": {
                        "volume": {
                          "value": 480,
                          "unit": "CUBIC_FT"
                        },
                        "weight": {
                          "value": 2500,
                          "unit": "KG"
                        },
                        "dimensions": {
                          "length": 20,
                          "width": 6,
                          "height": 4,
                          "unit": "FT"
                        }
                      }
                    }
                  }
                },
                "Ocean Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "CODE"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "3101428c-705c-4ec0-967b-7975bd1d3edc"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "1f7c4d02-919e-4d75-a2cf-7641ee271d58",
                        "deliveryStopId": "5e5eed3f-ab19-4e59-931d-3768c0d2d9b8",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "parties": [
                        {
                          "partyType": "SHIPPER",
                          "contactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "400 Montgomery St",
                              "2nd Floor"
                            ],
                            "postalCode": "94104",
                            "city": "San Francisco",
                            "state": "CA",
                            "country": "US"
                          }
                        },
                        {
                          "partyType": "NOTIFY_PARTY",
                          "contactInfo": {
                            "companyName": "Notify Party Company Name",
                            "givenName": "Henry",
                            "familyName": "Jacobsen",
                            "email": "h.jacobsen@notify-company.project44.com"
                          },
                          "addressInfo": {
                            "addressLines": [
                              "222 W. Merchandise Mart Plaza",
                              "Suite 1744"
                            ],
                            "postalCode": "60654",
                            "city": "Chicago",
                            "state": "IL",
                            "country": "US"
                          }
                        }
                      ],
                      "serviceType": "DOOR_TO_DOOR",
                      "bookingType": "FULL_CONTAINER_LOAD",
                      "incoterm": "DAP",
                      "containerCount": {
                        "reeferCount": {
                          "fortyFootContainerCount": 1
                        }
                      },
                      "accessorials": [
                        {
                          "code": "REFRIGERATED",
                          "details": {
                            "min": 32,
                            "max": 40,
                            "unit": "FAHRENHEIT"
                          }
                        }
                      ]
                    }
                  }
                },
                "Truckload Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "DOT_NUMBER",
                      "value": "01234567"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "fuelSurchargeRate": {
                      "currency": "USD",
                      "amount": 275
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "5a0498bb-fb7d-4805-90c9-da6acd246a73"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "911dcfe7-6980-4b28-a0d2-b8377ea88719",
                        "deliveryStopId": "8e076e12-ccf3-401d-b159-d308834a27af",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 10,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "loadPreference": "FULL",
                      "trailerType": "FLATBED",
                      "flatbedType": "DOUBLE_DROP"
                    }
                  }
                },
                "Multi Stop Truckload Booking": {
                  "value": {
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "capacityProviderIdentifier": {
                      "type": "CARRIER_SCAC",
                      "value": "JBHU"
                    },
                    "carrierContacts": [
                      {
                        "companyName": "Carrier Company Name",
                        "givenName": "John",
                        "familyName": "Hudson",
                        "email": "j.hudson@carrier-company.project44.com"
                      }
                    ],
                    "totalRate": {
                      "currency": "USD",
                      "amount": 3500
                    },
                    "fuelSurchargeRate": {
                      "currency": "USD",
                      "amount": 275
                    },
                    "rateIdentifiers": [
                      {
                        "source": "EXTERNAL",
                        "type": "CONTRACT",
                        "value": "contract-1234"
                      }
                    ],
                    "expirationDateTime": "2092-12-01T08:30:00+00:00",
                    "routeSegmentIds": [
                      "1475b8af-d75a-4a0b-b2a8-5bcaf3a20a4f",
                      "8bbcb5c1-5fcd-436f-8e47-57dbbde3074c",
                      "0cd3fb01-afca-4788-8104-70ccbeab75c8"
                    ],
                    "shipmentDetails": [
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "c3e64d20-65e1-4e39-b5a1-5d756ad92904",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 4,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      },
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "c444cd5a-14dd-414d-a603-9986671675f4",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 5,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      },
                      {
                        "pickupStopId": "04c2bb6c-f2e8-4133-b186-cd99eff6cd99",
                        "deliveryStopId": "5dce247e-4b2f-4076-bc8a-693da1f6b496",
                        "handlingUnits": [
                          {
                            "monetaryValue": {
                              "currency": "USD",
                              "amount": 1200
                            },
                            "quantity": 13,
                            "handlingUnitType": "PALLET",
                            "stackable": true,
                            "dimensions": {
                              "length": 48,
                              "width": 40,
                              "height": 40,
                              "unit": "IN"
                            },
                            "weight": {
                              "value": 2750,
                              "unit": "LB"
                            }
                          }
                        ],
                        "description": "Temperature-Sensitive Goods",
                        "identifiers": [
                          {
                            "type": "PURCHASE_ORDER",
                            "value": "1234"
                          }
                        ],
                        "accessorials": [
                          {
                            "code": "REFRIGERATED",
                            "details": {
                              "min": 32,
                              "max": 40,
                              "unit": "FAHRENHEIT"
                            }
                          }
                        ]
                      }
                    ],
                    "apiConfiguration": {
                      "bookingWebhookName": "Shipper WebhookName"
                    },
                    "shipperContactInfo": {
                      "companyName": "Shipper Company Name",
                      "givenName": "Jennifer",
                      "familyName": "Smith",
                      "email": "j.smith@shipper-company.project44.com"
                    },
                    "shippingDetails": {
                      "loadPreference": "FULL",
                      "trailerType": "FLATBED",
                      "flatbedType": "DOUBLE_DROP"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/bookings/{bookingId}/cancellations": {
      "post": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Cancel Booking",
        "description": "As a shipper, change a booking's status to `CANCELLED`.\nA shipper may cancel a booking at any time.",
        "operationId": "cancel_booking_bookings__bookingId__cancellations_post",
        "parameters": [
          {
            "description": "The project44-generated booking identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated booking identifier",
              "format": "uuid"
            },
            "name": "bookingId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/bookings/{bookingId}/carrier-notices": {
      "post": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Flag Booking As Under Review",
        "description": "As a Carrier, change a booking's status from `PROCESSING` to `UNDER_REVIEW`.\n\nThis endpoint is provided as a service to the shipper to inform them their request is under consideration,\nyet the Carrier is not yet ready to provide a full response.\n\nThe shipper will be notified of this activity.",
        "operationId": "flag_booking_as_under_review_bookings__bookingId__carrier_notices_post",
        "parameters": [
          {
            "description": "The project44-generated booking identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated booking identifier",
              "format": "uuid"
            },
            "name": "bookingId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/bookings/{bookingId}/responses": {
      "put": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Respond To Booking",
        "description": "As a Carrier, respond to a booking request, or update an existing response.\n\nACCEPT a booking by providing any identifiers applicable to the Shipment across\napplicable route-segments in the form of a `BookingResponse`.\nAll route-segments must be present in the response, even to specify there are no identifiers\nknown at the time of acceptance.\nA Carrier may update identifiers with this call if they have already accepted a booking.\n\nREJECT a booking by selecting a reason for rejection in the form of a `BookingRejection`.\n\nA Carrier may not PUT a Rejection to a booking after they have already accepted it.",
        "operationId": "respond_to_booking_bookings__bookingId__responses_put",
        "parameters": [
          {
            "description": "The project44-generated booking identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated booking identifier",
              "format": "uuid"
            },
            "name": "bookingId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/BookingResponse"
                  },
                  {
                    "$ref": "#/components/schemas/BookingRejection"
                  }
                ],
                "description": "Carrier response in the form of an Acceptance with identification information or a Rejection with a reason."
              },
              "examples": {
                "Air Booking Acceptance Response": {
                  "value": {
                    "shipmentIdentifiers": [
                      {
                        "type": "AIR_WAYBILL",
                        "value": "AW_123456789"
                      }
                    ],
                    "routeSegments": [
                      {
                        "routeSegmentId": "807127ac-e8dc-4a69-9032-48bcd62116a8",
                        "fromDate": "2092-12-10",
                        "toDate": "2092-12-12"
                      }
                    ],
                    "details": {}
                  }
                },
                "Ocean Booking Acceptance Response": {
                  "value": {
                    "shipmentIdentifiers": [
                      {
                        "type": "BOOKING_NUMBER",
                        "value": "123456789"
                      },
                      {
                        "type": "BILL_OF_LADING",
                        "value": "987654321"
                      },
                      {
                        "type": "CARRIER_NAME",
                        "value": "Ocean Carrier Name"
                      },
                      {
                        "type": "CARRIER_SCAC",
                        "value": "CLTD"
                      },
                      {
                        "type": "VESSEL_NAME",
                        "value": "Vessel Name"
                      },
                      {
                        "type": "VOYAGE_NUMBER",
                        "value": "1234"
                      }
                    ],
                    "routeSegments": [
                      {
                        "routeSegmentId": "5a0498bb-fb7d-4805-90c9-da6acd246a73",
                        "fromDate": "2092-12-10",
                        "toDate": "2092-12-12"
                      }
                    ],
                    "details": {
                      "portsDetails": [
                        {
                          "portType": "PORT_OF_DISCHARGE",
                          "estimatedDatetime": "2092-12-10T00:00:00+00:00"
                        },
                        {
                          "portType": "PORT_OF_LOADING",
                          "estimatedDatetime": "2092-12-10T00:00:00+00:00"
                        }
                      ],
                      "estimatedFinalDestinationDatetime": "2092-12-10T00:00:00+00:00",
                      "cutOffDetails": {
                        "cutOffDatetime": "2092-12-01T08:30:00+00:00",
                        "vesselCutOffDatetime": "2092-12-01T08:30:00+00:00",
                        "documentationCutOffDatetime": "2092-12-01T08:30:00+00:00"
                      }
                    }
                  }
                },
                "Truckload Booking Acceptance Response": {
                  "value": {
                    "shipmentIdentifiers": [
                      {
                        "type": "BOOKING_NUMBER",
                        "value": "123456789"
                      },
                      {
                        "type": "BILL_OF_LADING",
                        "value": "987654321"
                      }
                    ],
                    "routeSegments": [
                      {
                        "routeSegmentId": "5a0498bb-fb7d-4805-90c9-da6acd246a73",
                        "fromDate": "2092-12-10",
                        "toDate": "2092-12-12"
                      }
                    ],
                    "details": {}
                  }
                },
                "Booking Rejection Response": {
                  "value": {
                    "reason": "SHORT_ON_STAFF",
                    "notes": "We are not able to find a driver!"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Booking"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/ltl/electronic-bols": {
      "post": {
        "tags": [
          "LTL: Electronic BOL"
        ],
        "summary": "Create Electronic Bol",
        "description": "As a shipper, create an eBOL request to send to a Carrier. Aligned with https://digitalltl.nmfta.org/api-documentation/v2.1.0. Any difference in naming, structure, and other conventions in comparison with other project44 APIs are for this reason.",
        "operationId": "create_electronic_bol_ltl_electronic_bols_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestEbol"
              },
              "examples": {
                "Minimal EBOL request": {
                  "value": {
                    "bol": {
                      "requestedPickupDate": "2092-12-01T08:30:00",
                      "function": "Create",
                      "isTest": true,
                      "requestorRole": "Shipper"
                    },
                    "version": "2.1.0",
                    "referenceNumbers": {
                      "additionalReferences": [
                        {
                          "name": "CAPACITY_PROVIDER_ACCOUNT_GROUP_CODE",
                          "value": "DEFAULT"
                        },
                        {
                          "name": "CAPACITY_PROVIDER_ACCOUNT_CODE",
                          "value": "ABFS"
                        }
                      ]
                    },
                    "payment": {
                      "terms": "Prepaid"
                    },
                    "commodities": {
                      "lineItemLayout": "Nested",
                      "handlingUnits": [
                        {
                          "count": 2,
                          "type": "PAT",
                          "weight": 500
                        }
                      ]
                    },
                    "origin": {
                      "name": "Company XYZ",
                      "address1": "275 6TH AVE",
                      "city": "SHERMAN",
                      "stateProvince": "MS",
                      "postalCode": "38869",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555555"
                      }
                    },
                    "destination": {
                      "name": "Company 123",
                      "address1": "505 PEGASUS PARKWAY",
                      "city": "LAGRANGE",
                      "stateProvince": "GA",
                      "postalCode": "30240",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555556"
                      }
                    },
                    "billTo": {
                      "name": "Company 123",
                      "address1": "505 PEGASUS PARKWAY",
                      "city": "LAGRANGE",
                      "stateProvince": "GA",
                      "postalCode": "30240",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555556"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ebol"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/ltl/electronic-bols/by-pro-number/{proNumber}": {
      "put": {
        "tags": [
          "LTL: Electronic BOL"
        ],
        "summary": "Update Electronic Bol",
        "description": "As a shipper, update an eBOL request to send to a Carrier. Aligned with https://digitalltl.nmfta.org/api-documentation/v2.1.0. Any difference in naming, structure, and other conventions in comparison with other project44 APIs are for this reason.",
        "operationId": "update_electronic_bol_ltl_electronic_bols__pro__put",
        "parameters": [
          {
            "description": "PRO Number of an eBOL to update.",
            "required": true,
            "schema": {
              "type": "string",
              "description": "PRO Number of an eBOL to update."
            },
            "name": "proNumber",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestEbol"
              },
              "examples": {
                "Minimal EBOL request": {
                  "value": {
                    "bol": {
                      "requestedPickupDate": "2092-12-01T08:30:00",
                      "function": "Create",
                      "isTest": true,
                      "requestorRole": "Shipper"
                    },
                    "version": "2.1.0",
                    "referenceNumbers": {
                      "additionalReferences": [
                        {
                          "name": "CAPACITY_PROVIDER_ACCOUNT_GROUP_CODE",
                          "value": "DEFAULT"
                        },
                        {
                          "name": "CAPACITY_PROVIDER_ACCOUNT_CODE",
                          "value": "ABFS"
                        }
                      ]
                    },
                    "payment": {
                      "terms": "Prepaid"
                    },
                    "commodities": {
                      "lineItemLayout": "Nested",
                      "handlingUnits": [
                        {
                          "count": 2,
                          "type": "PAT",
                          "weight": 500
                        }
                      ]
                    },
                    "origin": {
                      "name": "Company XYZ",
                      "address1": "275 6TH AVE",
                      "city": "SHERMAN",
                      "stateProvince": "MS",
                      "postalCode": "38869",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555555"
                      }
                    },
                    "destination": {
                      "name": "Company 123",
                      "address1": "505 PEGASUS PARKWAY",
                      "city": "LAGRANGE",
                      "stateProvince": "GA",
                      "postalCode": "30240",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555556"
                      }
                    },
                    "billTo": {
                      "name": "Company 123",
                      "address1": "505 PEGASUS PARKWAY",
                      "city": "LAGRANGE",
                      "stateProvince": "GA",
                      "postalCode": "30240",
                      "country": "USA",
                      "contact": {
                        "phone": "5555555556"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ebol"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "delete": {
        "tags": [
          "LTL: Electronic BOL"
        ],
        "summary": "Delete Electronic Bol",
        "description": "As a shipper, delete an eBOL request to send to a Carrier. Aligned with https://digitalltl.nmfta.org/api-documentation/v2.1.0. Any difference in naming, structure, and other conventions in comparison with other project44 APIs are for this reason.",
        "operationId": "delete_electronic_bol_ltl_electronic_bols__pro__delete",
        "parameters": [
          {
            "description": "PRO Number of an eBOL to delete.",
            "required": true,
            "schema": {
              "type": "string",
              "description": "PRO Number of an eBOL to delete."
            },
            "name": "proNumber",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/packaging": {
      "get": {
        "tags": [
          "Multi-Modal: Packaging"
        ],
        "summary": "Search Packages",
        "description": "As a shipper, search for packages with various filters. Supports filtering by tenant, identifiers, SKU identifiers, and origin/destination location.",
        "operationId": "get_packages_packaging_get",
        "parameters": [
          {
            "description": "The shipper tenant ID to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The shipper tenant ID to filter packages."
            },
            "name": "shipperTenantId",
            "in": "query"
          },
          {
            "description": "The shipper tenant UUID to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The shipper tenant UUID to filter packages."
            },
            "name": "shipperTenantUuid",
            "in": "query"
          },
          {
            "description": "The type of the package identifier to search against.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The type of the package identifier to search against."
            },
            "name": "identifier.type",
            "in": "query"
          },
          {
            "description": "The value of the package identifier to search for; this filter is non-partial.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The value of the package identifier to search for; this filter is non-partial."
            },
            "name": "identifier.value",
            "in": "query"
          },
          {
            "description": "The SKU identifier value to search for in package items.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The SKU identifier value to search for in package items."
            },
            "name": "skuIdentifier",
            "in": "query"
          },
          {
            "description": "The origin city to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The origin city to filter packages."
            },
            "name": "origin.city",
            "in": "query"
          },
          {
            "description": "The origin state to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The origin state to filter packages."
            },
            "name": "origin.state",
            "in": "query"
          },
          {
            "description": "The origin country to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The origin country to filter packages."
            },
            "name": "origin.country",
            "in": "query"
          },
          {
            "description": "The origin postal code to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The origin postal code to filter packages."
            },
            "name": "origin.postalCode",
            "in": "query"
          },
          {
            "description": "The destination city to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The destination city to filter packages."
            },
            "name": "destination.city",
            "in": "query"
          },
          {
            "description": "The destination state to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The destination state to filter packages."
            },
            "name": "destination.state",
            "in": "query"
          },
          {
            "description": "The destination country to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The destination country to filter packages."
            },
            "name": "destination.country",
            "in": "query"
          },
          {
            "description": "The destination postal code to filter packages.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The destination postal code to filter packages."
            },
            "name": "destination.postalCode",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            },
            "name": "pageNumber",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            },
            "name": "pageSize",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageResponsePage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "post": {
        "tags": [
          "Multi-Modal: Packaging"
        ],
        "summary": "Create Package",
        "description": "As a shipper, create a package with items, physical details, identifiers, and accessorials for shipment planning.",
        "operationId": "create_package_packaging_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUpdatePackage"
              },
              "examples": {
                "Basic Package": {
                  "description": "Create a basic package with items and identifiers.",
                  "value": {
                    "items": [
                      {
                        "identifiers": [
                          {
                            "type": "SKU",
                            "value": "SKU-12345"
                          }
                        ],
                        "orderIdentifier": {
                          "value": "PO-12345",
                          "type": "PURCHASE_ORDER"
                        },
                        "unitQuantity": 10
                      }
                    ],
                    "package": {
                      "type": "PALLET",
                      "dimensions": {
                        "length": 48,
                        "width": 40,
                        "height": 48,
                        "unit": "IN"
                      },
                      "weight": {
                        "value": 500,
                        "unit": "LB"
                      }
                    },
                    "identifiers": [
                      {
                        "type": "DELIVERY_NUMBER",
                        "value": "DEL-12345"
                      }
                    ],
                    "isStackable": true,
                    "accessorials": []
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/packaging/{packageId}": {
      "get": {
        "tags": [
          "Multi-Modal: Packaging"
        ],
        "summary": "Get Package",
        "description": "As a shipper, fetch a package by its unique identifier.",
        "operationId": "get_package_packaging_packageId_get",
        "parameters": [
          {
            "description": "The project44-generated package identifier.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The project44-generated package identifier."
            },
            "name": "packageId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "put": {
        "tags": [
          "Multi-Modal: Packaging"
        ],
        "summary": "Update Package",
        "description": "As a shipper, update an existing package with items, physical details, identifiers, and accessorials.",
        "operationId": "update_package_packaging_packageId_put",
        "parameters": [
          {
            "description": "The project44-generated package identifier.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The project44-generated package identifier."
            },
            "name": "packageId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUpdatePackage"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackageResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/shipments": {
      "get": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Get Shipments",
        "description": "As a shipper, fetch a shipment created for booking.",
        "operationId": "get_shipments_shipments_get",
        "parameters": [
          {
            "description": "The type of the custom shipment identifier to search against.",
            "required": false,
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/LogisticsIdentifierType"
                }
              ],
              "description": "The type of the custom shipment identifier to search against."
            },
            "name": "identifier.type",
            "in": "query"
          },
          {
            "description": "The value of the custom shipment identifier to search for; this filter is non-partial.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The value of the custom shipment identifier to search for; this filter is non-partial."
            },
            "name": "identifier.value",
            "in": "query"
          },
          {
            "description": "The name of the custom shipment attribute to search against.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The name of the custom shipment attribute to search against."
            },
            "name": "attribute.name",
            "in": "query"
          },
          {
            "description": "The values of the custom shipment attribute to search for; this filter is non-partial.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The values of the custom shipment attribute to search for; this filter is non-partial."
            },
            "name": "attribute.values",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "default": 1
            },
            "name": "pageNumber",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "maximum": 100,
              "type": "integer",
              "default": 10
            },
            "name": "pageSize",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookedShipmentPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "post": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Create Shipment",
        "description": "As a shipper, create a shipment for booking.",
        "operationId": "create_shipment_shipments_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateBookedShipment"
              },
              "examples": {
                "Basic Shipment": {
                  "description": "One may create a parent shipment definition without any bookings if they would like to return later and add them on.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "b996b45d-94cb-42ac-aa6f-cd8c7cfe7a5b",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "fromStopId": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
                          "toStopId": "b996b45d-94cb-42ac-aa6f-cd8c7cfe7a5b"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ]
                  }
                },
                "Shipment Containing Truckload Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "467db976-157b-46b8-9d1e-1d4e45df8745",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "a12bf71f-1c35-4aa0-8354-a1ff07cf921b",
                          "fromStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                          "toStopId": "467db976-157b-46b8-9d1e-1d4e45df8745"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "DOT_NUMBER",
                          "value": "01234567"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "a12bf71f-1c35-4aa0-8354-a1ff07cf921b"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                            "deliveryStopId": "467db976-157b-46b8-9d1e-1d4e45df8745",
                            "handlingUnits": [
                              {
                                "description": "Chicken meat",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "REFRIGERATED",
                          "trailerDetails": {
                            "refrigeratedClass": "CHILLED"
                          },
                          "trailerLength": {
                            "value": 52,
                            "unit": "FT"
                          },
                          "trailerVolume": {
                            "value": 2548,
                            "unit": "CUBIC_FT"
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 4,
                                "max": 10,
                                "unit": "CELSIUS"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Truckload Booking with Multiple Stops": {
                  "description": "One may create a truckload shipment with a booking that contains multiple stops.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                          "type": "PICKUP_DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                          "type": "PICKUP_DELIVERY",
                          "arrivalDate": "2092-12-14",
                          "location": {
                            "address": {
                              "addressLines": [
                                "400 Montgomery St",
                                "2nd Floor"
                              ],
                              "postalCode": "94104",
                              "city": "San Francisco",
                              "state": "CA",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-16",
                          "location": {
                            "address": {
                              "addressLines": [
                                "Alameda Santos, 700 - Jardim Paulista"
                              ],
                              "postalCode": "01418-100",
                              "city": "São Paulo",
                              "state": "São Paulo",
                              "country": "BR"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "7af9544b-5edc-478f-bf5f-f40670a48851",
                          "fromStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                          "toStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8"
                        },
                        {
                          "id": "1ee97fb8-f993-4d4c-9f42-03eb620d8e2c",
                          "fromStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                          "toStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc"
                        },
                        {
                          "id": "5cc1c0aa-9927-45ac-b2ef-f3bf2a8f1730",
                          "fromStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                          "toStopId": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "JBHU"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "7af9544b-5edc-478f-bf5f-f40670a48851",
                          "1ee97fb8-f993-4d4c-9f42-03eb620d8e2c",
                          "5cc1c0aa-9927-45ac-b2ef-f3bf2a8f1730"
                        ],
                        "shipmentDetails": [
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 4,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                }
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          },
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 5,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                }
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          },
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 13,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                }
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "FLATBED",
                          "flatbedType": "DOUBLE_DROP"
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Truckload Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                          "fromStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                          "toStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "DOT_NUMBER",
                          "value": "01234567"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "57a01ada-d3a5-4072-a9b9-8f2c961371b0"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "deliveryStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                            "handlingUnits": [
                              {
                                "description": "Chicken meat",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "REFRIGERATED",
                          "trailerDetails": {
                            "refrigeratedClass": "CHILLED"
                          },
                          "trailerLength": {
                            "value": 52,
                            "unit": "FT"
                          },
                          "trailerVolume": {
                            "value": 2548,
                            "unit": "CUBIC_FT"
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 4,
                                "max": 10,
                                "unit": "CELSIUS"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Ocean Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "a7622b31-0294-4be4-9275-a24c16db6658",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "fb9afbf5-e573-4722-b735-df631c0a68aa",
                          "fromStopId": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                          "toStopId": "a7622b31-0294-4be4-9275-a24c16db6658"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "CODE"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "fb9afbf5-e573-4722-b735-df631c0a68aa"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                            "deliveryStopId": "a7622b31-0294-4be4-9275-a24c16db6658",
                            "handlingUnits": [
                              {
                                "description": "Chicken meat",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "NOTIFY_PARTY",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "DOOR_TO_DOOR",
                          "bookingType": "FULL_CONTAINER_LOAD",
                          "incoterm": "DAP",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          },
                          "containerCount": {
                            "reeferCount": {
                              "fortyFootContainerCount": 1
                            }
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 32,
                                "max": 40,
                                "unit": "FAHRENHEIT"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Ocean Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                          "fromStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                          "toStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "CODE"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "5d1d83ed-a868-4f33-b1b0-eef390d0822b"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "deliveryStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "NOTIFY_PARTY",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "DOOR_TO_DOOR",
                          "bookingType": "FULL_CONTAINER_LOAD",
                          "incoterm": "DAP",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          },
                          "containerCount": {
                            "reeferCount": {
                              "fortyFootContainerCount": 1
                            }
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 32,
                                "max": 40,
                                "unit": "FAHRENHEIT"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Air Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "CR_1A2B3C4D"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "type": "PICKUP",
                          "arrivalDate": "2026-03-16",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "SXB"
                              },
                              {
                                "type": "AIRPORT_ICAO",
                                "value": "LFST"
                              }
                            ]
                          }
                        },
                        {
                          "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                          "type": "DELIVERY",
                          "arrivalDate": "2026-03-20",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "PVG"
                              },
                              {
                                "type": "AIRPORT_IATA",
                                "value": "ZSPD"
                              }
                            ]
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                          "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "IPSH"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2026-03-11T08:30:00+00:00",
                        "routeSegmentIds": [
                          "c1816420-f5a7-4321-89e3-3a8a4acab734"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Custom accessories",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "BOOKING_AGENT",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "PORT_TO_PORT",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          }
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Air Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "CR_1A2B3C4D"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "type": "PICKUP",
                          "arrivalDate": "2026-03-16",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "SXB"
                              },
                              {
                                "type": "AIRPORT_ICAO",
                                "value": "LFST"
                              }
                            ]
                          }
                        },
                        {
                          "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                          "type": "DELIVERY",
                          "arrivalDate": "2026-03-20",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "PVG"
                              },
                              {
                                "type": "AIRPORT_IATA",
                                "value": "ZSPD"
                              }
                            ]
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                          "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "IPSH"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2026-03-11T08:30:00+00:00",
                        "routeSegmentIds": [
                          "c1816420-f5a7-4321-89e3-3a8a4acab734"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Custom accessories",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "BOOKING_AGENT",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "PORT_TO_PORT",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookedShipment"
                },
                "examples": {
                  "Shipment Containing Truckload Booking - Full Response": {
                    "summary": "Shipment Containing Truckload Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "SHIPMENT-12345"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "type": "PICKUP",
                            "arrivalDate": "2092-12-10",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          },
                          {
                            "id": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                            "type": "DELIVERY",
                            "arrivalDate": "2092-12-12",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "3800 N Lamar Blvd",
                                  "Suite 210"
                                ],
                                "postalCode": "78756",
                                "city": "Austin",
                                "state": "TX",
                                "country": "US"
                              }
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                            "fromStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "toStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "DOT_NUMBER",
                            "value": "01234567"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.project44.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2092-12-01T08:30:00+00:00",
                          "routeSegmentIds": [
                            "57a01ada-d3a5-4072-a9b9-8f2c961371b0"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                              "deliveryStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                              "handlingUnits": [
                                {
                                  "description": "Chicken meat",
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "items": [
                                    {
                                      "description": "Chicken meat",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": "03968e4f-22fe-43ff-b76f-e77220456201"
                            }
                          ],
                          "apiConfiguration": {
                            "bookingWebhookName": "Shipper WebhookName"
                          },
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "shippingDetails": {
                            "loadPreference": "FULL",
                            "trailerType": "REFRIGERATED",
                            "trailerDetails": {
                              "refrigeratedClass": "CHILLED"
                            },
                            "trailerLength": {
                              "value": 52,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 2548,
                              "unit": "CUBIC_FT"
                            },
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 4,
                                  "max": 10,
                                  "unit": "CELSIUS"
                                }
                              }
                            ]
                          },
                          "id": "81b0523b-bcf6-421d-9da0-ebef5ad6de3b",
                          "status": "BOOKED",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "SHIPMENT-12345"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                              "fromStop": {
                                "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              },
                              "toStop": {
                                "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              }
                            }
                          ],
                          "carrierResponseMethod": "EMAIL",
                          "bookingSourceMethod": "API",
                          "transportationMode": "TRUCKLOAD",
                          "masterShipmentId": "30fd2695-a419-4ecc-b18a-52a2e06bcaf5",
                          "carrierProvidedIdentifiers": [
                            {
                              "type": "BOOKING_NUMBER",
                              "value": "BN-1223334444"
                            },
                            {
                              "type": "DRIVER_MOBILE_PHONE_NUMBER",
                              "value": "5556667777"
                            }
                          ],
                          "capacityProviderReferenceKeys": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "createdDateTime": "2024-03-25T10:39:05",
                          "lastModifiedDateTime": "2024-03-25T10:39:05",
                          "lastAcceptedDateTime": "2024-03-25T10:39:05"
                        }
                      ],
                      "id": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
                      "createdDateTime": "2024-03-25T10:39:05",
                      "lastModifiedDateTime": "2024-03-25T10:39:05"
                    }
                  },
                  "Shipment Containing Ocean Booking - Full Response": {
                    "summary": "Shipment Containing Ocean Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "SHIPMENT-12345"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "type": "PICKUP",
                            "arrivalDate": "2092-12-10",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          },
                          {
                            "id": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                            "type": "DELIVERY",
                            "arrivalDate": "2092-12-12",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "3800 N Lamar Blvd",
                                  "Suite 210"
                                ],
                                "postalCode": "78756",
                                "city": "Austin",
                                "state": "TX",
                                "country": "US"
                              }
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                            "fromStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "toStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "9389da43-5f35-4ce5-94a5-7419c2b55580",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CODE"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.project44.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2092-12-01T08:30:00+00:00",
                          "routeSegmentIds": [
                            "5d1d83ed-a868-4f33-b1b0-eef390d0822b"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                              "deliveryStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                              "handlingUnits": [
                                {
                                  "description": "Chicken meat",
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "items": [
                                    {
                                      "description": "Chicken meat",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": "54f7ab2b-c548-4e24-b9de-7bca4f05bba6"
                            }
                          ],
                          "apiConfiguration": {
                            "bookingWebhookName": "Shipper WebhookName"
                          },
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "shippingDetails": {
                            "parties": [
                              {
                                "partyType": "SHIPPER",
                                "contactInfo": {
                                  "companyName": "Shipper Company Name",
                                  "givenName": "Jennifer",
                                  "familyName": "Smith",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "j.smith@shipper-company.project44.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "400 Montgomery St",
                                    "2nd Floor"
                                  ],
                                  "postalCode": "94104",
                                  "city": "San Francisco",
                                  "state": "CA",
                                  "country": "US"
                                },
                                "vatNumber": "vat-123"
                              },
                              {
                                "partyType": "NOTIFY_PARTY",
                                "contactInfo": {
                                  "companyName": "Notify Party Company Name",
                                  "givenName": "Henry",
                                  "familyName": "Jacobsen",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "h.jacobsen@notify-company.project44.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "222 W. Merchandise Mart Plaza",
                                    "Suite 1744"
                                  ],
                                  "postalCode": "60654",
                                  "city": "Chicago",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "vatNumber": "vat-234"
                              }
                            ],
                            "serviceType": "DOOR_TO_DOOR",
                            "bookingType": "FULL_CONTAINER_LOAD",
                            "incoterm": "DAP",
                            "cargoMeasurements": {
                              "volume": {
                                "value": 480,
                                "unit": "CUBIC_FT"
                              },
                              "weight": {
                                "value": 2500,
                                "unit": "KG"
                              },
                              "dimensions": {
                                "length": 20,
                                "width": 6,
                                "height": 4,
                                "unit": "FT"
                              }
                            },
                            "containerCount": {
                              "reeferCount": {
                                "twentyFootContainerCount": 0,
                                "fortyFootContainerCount": 1,
                                "fortyFootHighCubeCount": 0
                              }
                            },
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ],
                            "portsDetails": [
                              [
                                {
                                  "portType": "PORT_OF_LOADING",
                                  "estimatedDatetime": "2092-07-12T16:00:00+00:00"
                                }
                              ]
                            ],
                            "estimatedFinalDestinationDatetime": "2092-07-14T16:00:00",
                            "cutOffDetails": {
                              "cutOffDatetime": "2092-07-09T16:00:00+00:00",
                              "vesselCutOffDatetime": "2092-07-11T16:00:00",
                              "documentationCutOffDatetime": "2092-07-11T16:00:00"
                            },
                            "containerDetails": [
                              {
                                "containerId": "BMOU5100160",
                                "referenceKeys": [
                                  {
                                    "name": "attribute name",
                                    "values": [
                                      "string value 1",
                                      "string value 2"
                                    ]
                                  }
                                ]
                              }
                            ]
                          },
                          "id": "88da97f8-d62e-449e-9bc5-00846522b1bc",
                          "status": "BOOKED",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "SHIPMENT-12345"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                              "fromStop": {
                                "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              },
                              "toStop": {
                                "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              }
                            }
                          ],
                          "carrierResponseMethod": "EDI",
                          "bookingSourceMethod": "API",
                          "transportationMode": "OCEAN",
                          "masterShipmentId": "4b0e8fef-9df7-4e5c-b55f-3144a35da7c9",
                          "carrierProvidedIdentifiers": [
                            {
                              "type": "BOOKING_NUMBER",
                              "value": "BN-1223334444"
                            },
                            {
                              "type": "CARRIER_NAME",
                              "value": "EON Ltd."
                            },
                            {
                              "type": "CARRIER_SCAC",
                              "value": "ELTD"
                            },
                            {
                              "type": "VESSEL_NAME",
                              "value": "Infinity"
                            },
                            {
                              "type": "VOYAGE_NUMBER",
                              "value": "117"
                            }
                          ],
                          "capacityProviderReferenceKeys": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "createdDateTime": "2024-03-25T10:39:05",
                          "lastModifiedDateTime": "2024-03-25T10:39:05",
                          "lastAcceptedDateTime": "2024-03-25T10:39:05"
                        }
                      ],
                      "id": "9389da43-5f35-4ce5-94a5-7419c2b55580",
                      "createdDateTime": "2024-03-25T10:39:05",
                      "lastModifiedDateTime": "2024-03-25T10:39:05"
                    }
                  },
                  "Shipment Containing Air Booking - Full Response": {
                    "summary": "Shipment Containing Air Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "CR_1A2B3C4D"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "type": "PICKUP",
                            "arrivalDate": "2026-03-16",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "id": "32b27c58-91bc-4bbe-89c8-f1ed6fe80449",
                              "name": null,
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "SXB"
                                },
                                {
                                  "type": "AIRPORT_ICAO",
                                  "value": "LFST"
                                }
                              ],
                              "address": null,
                              "geoCoordinates": null
                            }
                          },
                          {
                            "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "type": "DELIVERY",
                            "arrivalDate": "2026-03-20",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "id": "06a8e6f3-a049-4da3-9948-597a73b3a367",
                              "name": null,
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "PVG"
                                },
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "ZSPD"
                                }
                              ],
                              "address": null,
                              "geoCoordinates": null
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                            "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "3aedc920-e008-41c8-9221-60a6a1844d9e",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "IPSH"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2026-03-11T08:30:00+00:00",
                          "routeSegmentIds": [
                            "c1816420-f5a7-4321-89e3-3a8a4acab734"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                              "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                              "handlingUnits": [
                                {
                                  "description": null,
                                  "freightClass": null,
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "nmfcItemCode": null,
                                  "nmfcSubCode": null,
                                  "hazmatDetail": null,
                                  "items": [
                                    {
                                      "description": "Custom accessories",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "items": [],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": null
                            }
                          ],
                          "apiConfiguration": null,
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.com"
                          },
                          "shippingDetails": {
                            "parties": [
                              {
                                "partyType": "SHIPPER",
                                "contactInfo": {
                                  "companyName": "Shipper Company Name",
                                  "givenName": "Jennifer",
                                  "familyName": "Smith",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "j.smith@shipper-company.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "400 Montgomery St",
                                    "2nd Floor"
                                  ],
                                  "postalCode": "94104",
                                  "city": "San Francisco",
                                  "state": "CA",
                                  "country": "US"
                                },
                                "locationIdentifiers": null,
                                "vatNumber": "vat-123",
                                "identifyingCodes": null
                              },
                              {
                                "partyType": "BOOKING_AGENT",
                                "contactInfo": {
                                  "companyName": "Notify Party Company Name",
                                  "givenName": "Henry",
                                  "familyName": "Jacobsen",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "h.jacobsen@notify-company.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "222 W. Merchandise Mart Plaza",
                                    "Suite 1744"
                                  ],
                                  "postalCode": "60654",
                                  "city": "Chicago",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "locationIdentifiers": null,
                                "vatNumber": "vat-234",
                                "identifyingCodes": null
                              }
                            ],
                            "serviceType": "PORT_TO_PORT",
                            "incoterm": null,
                            "cargoMeasurements": {
                              "volume": {
                                "value": 480,
                                "unit": "CUBIC_FT"
                              },
                              "weight": {
                                "value": 2500,
                                "unit": "KG"
                              },
                              "dimensions": {
                                "length": 20,
                                "width": 6,
                                "height": 4,
                                "unit": "FT"
                              }
                            },
                            "accessorials": [],
                            "airportDetails": [],
                            "estimatedFinalDestinationDateTime": null
                          },
                          "bookingIdentifiers": [],
                          "rateRequestId": null,
                          "quoteId": null,
                          "id": "a79666f8-26fd-414e-af7d-d7de6fe2106a",
                          "status": "PROCESSING",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "CR_1A2B3C4D"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                              "fromStop": {
                                "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                                "type": "PICKUP",
                                "arrivalDate": "2026-03-16",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "id": "32b27c58-91bc-4bbe-89c8-f1ed6fe80449",
                                  "name": null,
                                  "identifiers": [
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "SXB"
                                    },
                                    {
                                      "type": "AIRPORT_ICAO",
                                      "value": "LFST"
                                    }
                                  ],
                                  "address": null,
                                  "geoCoordinates": null
                                }
                              },
                              "toStop": {
                                "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                                "type": "DELIVERY",
                                "arrivalDate": "2026-03-20",
                                "arrivalAppointmentWindow": {
                                  "startTime": "15:15:00",
                                  "endTime": "17:00:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "id": "06a8e6f3-a049-4da3-9948-597a73b3a367",
                                  "name": null,
                                  "identifiers": [
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "PVG"
                                    },
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "ZSPD"
                                    }
                                  ],
                                  "address": null,
                                  "geoCoordinates": null
                                }
                              }
                            }
                          ],
                          "rejectionReason": null,
                          "carrierResponseMethod": "API",
                          "automatedFailureReason": null,
                          "bookingSourceMethod": "API",
                          "carrierRejectionNotes": null,
                          "transportationMode": "AIR",
                          "masterShipmentId": null,
                          "carrierProvidedIdentifiers": [],
                          "capacityProviderReferenceKeys": [],
                          "createdDateTime": "2026-03-09T15:46:23",
                          "lastModifiedDateTime": "2026-03-09T15:46:23",
                          "lastAcceptedDateTime": null,
                          "rejectedDateTime": null,
                          "cancelledDateTime": null
                        }
                      ],
                      "id": "3aedc920-e008-41c8-9221-60a6a1844d9e",
                      "createdDateTime": "2026-03-09T15:46:23",
                      "lastModifiedDateTime": "2026-03-09T15:46:23"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/shipments/{shipmentId}": {
      "get": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Get Shipment",
        "description": "As a shipper, fetch a shipment created for booking.",
        "operationId": "get_shipment_shipments__shipmentId__get",
        "parameters": [
          {
            "description": "The project44-generated shipment identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated shipment identifier",
              "format": "uuid"
            },
            "name": "shipmentId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookedShipment"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "put": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Update Shipment",
        "description": "As a shipper, update a shipment for booking.",
        "operationId": "update_shipment_shipments__shipmentId__put",
        "parameters": [
          {
            "description": "The project44-generated shipment identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated shipment identifier",
              "format": "uuid"
            },
            "name": "shipmentId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBookedShipment"
              },
              "examples": {
                "Basic Shipment": {
                  "description": "One may create a parent shipment definition without any bookings if they would like to return later and add them on.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "b996b45d-94cb-42ac-aa6f-cd8c7cfe7a5b",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "fromStopId": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
                          "toStopId": "b996b45d-94cb-42ac-aa6f-cd8c7cfe7a5b"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": []
                  }
                },
                "Shipment Containing Truckload Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "467db976-157b-46b8-9d1e-1d4e45df8745",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "a12bf71f-1c35-4aa0-8354-a1ff07cf921b",
                          "fromStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                          "toStopId": "467db976-157b-46b8-9d1e-1d4e45df8745"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "DOT_NUMBER",
                          "value": "01234567"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "a12bf71f-1c35-4aa0-8354-a1ff07cf921b"
                        ],
                        "shipmentDetails": [
                          {
                            "pickupStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
                            "deliveryStopId": "467db976-157b-46b8-9d1e-1d4e45df8745",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "FLATBED",
                          "flatbedType": "DOUBLE_DROP",
                          "accessorials": []
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Truckload Booking with Multiple Stops": {
                  "description": "One may create a truckload shipment with a booking that contains multiple stops.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                          "type": "PICKUP_DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                          "type": "PICKUP_DELIVERY",
                          "arrivalDate": "2092-12-14",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "400 Montgomery St",
                                "2nd Floor"
                              ],
                              "postalCode": "94104",
                              "city": "San Francisco",
                              "state": "CA",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-16",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "Alameda Santos, 700 - Jardim Paulista"
                              ],
                              "postalCode": "01418-100",
                              "city": "São Paulo",
                              "state": "São Paulo",
                              "country": "BR"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "7af9544b-5edc-478f-bf5f-f40670a48851",
                          "fromStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                          "toStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8"
                        },
                        {
                          "id": "1ee97fb8-f993-4d4c-9f42-03eb620d8e2c",
                          "fromStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                          "toStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc"
                        },
                        {
                          "id": "5cc1c0aa-9927-45ac-b2ef-f3bf2a8f1730",
                          "fromStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                          "toStopId": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "JBHU"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "7af9544b-5edc-478f-bf5f-f40670a48851",
                          "1ee97fb8-f993-4d4c-9f42-03eb620d8e2c",
                          "5cc1c0aa-9927-45ac-b2ef-f3bf2a8f1730"
                        ],
                        "shipmentDetails": [
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "5c685f07-2171-45a8-a90d-ac88e118a5b8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 4,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          },
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "b4c42d61-28c9-487d-a3f2-35017d5876dc",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 5,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          },
                          {
                            "pickupStopId": "a7d4f409-1972-4e3e-be96-db4dae543cef",
                            "deliveryStopId": "3f74b1bb-bc65-45d5-b67d-c8d6e7642fc5",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 13,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "55566667778",
                          "mobilePhoneNumber": "55566667777",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "FLATBED",
                          "flatbedType": "DOUBLE_DROP",
                          "accessorials": []
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Truckload Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                          "fromStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                          "toStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "DOT_NUMBER",
                          "value": "01234567"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "57a01ada-d3a5-4072-a9b9-8f2c961371b0"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "deliveryStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                            "handlingUnits": [
                              {
                                "description": "Chicken meat",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "55566667778",
                          "mobilePhoneNumber": "55566667777",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "loadPreference": "FULL",
                          "trailerType": "REFRIGERATED",
                          "trailerDetails": {
                            "refrigeratedClass": "CHILLED"
                          },
                          "trailerLength": {
                            "value": 52,
                            "unit": "FT"
                          },
                          "trailerVolume": {
                            "value": 2548,
                            "unit": "CUBIC_FT"
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 4,
                                "max": 10,
                                "unit": "CELSIUS"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Ocean Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "a7622b31-0294-4be4-9275-a24c16db6658",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "fb9afbf5-e573-4722-b735-df631c0a68aa",
                          "fromStopId": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                          "toStopId": "a7622b31-0294-4be4-9275-a24c16db6658"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "CODE"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "fb9afbf5-e573-4722-b735-df631c0a68aa"
                        ],
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fc273d43-b10e-40a2-9e6e-fa538cd361ac",
                            "deliveryStopId": "a7622b31-0294-4be4-9275-a24c16db6658",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "55566667778",
                          "mobilePhoneNumber": "55566667777",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "55566667778",
                                "mobilePhoneNumber": "55566667777",
                                "email": "j.smith@shipper-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              }
                            },
                            {
                              "partyType": "NOTIFY_PARTY",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "email": "h.jacobsen@notify-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          ],
                          "serviceType": "DOOR_TO_DOOR",
                          "bookingType": "FULL_CONTAINER_LOAD",
                          "incoterm": "DAP",
                          "containerCount": {
                            "reeferCount": {
                              "twentyFootContainerCount": 0,
                              "fortyFootContainerCount": 1,
                              "fortyFootHighCubeCount": 0
                            }
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 32,
                                "max": 40,
                                "unit": "FAHRENHEIT"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Ocean Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                          "type": "PICKUP",
                          "arrivalDate": "2092-12-10",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "222 W. Merchandise Mart Plaza",
                                "Suite 1744"
                              ],
                              "postalCode": "60654",
                              "city": "Chicago",
                              "state": "IL",
                              "country": "US"
                            }
                          }
                        },
                        {
                          "id": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                          "type": "DELIVERY",
                          "arrivalDate": "2092-12-12",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "contacts": [],
                          "accessorials": [],
                          "location": {
                            "identifiers": [],
                            "address": {
                              "addressLines": [
                                "3800 N Lamar Blvd",
                                "Suite 210"
                              ],
                              "postalCode": "78756",
                              "city": "Austin",
                              "state": "TX",
                              "country": "US"
                            }
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                          "fromStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                          "toStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "CODE"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "5d1d83ed-a868-4f33-b1b0-eef390d0822b"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "deliveryStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                            "handlingUnits": [
                              {
                                "description": "Chicken meat",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "NOTIFY_PARTY",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "DOOR_TO_DOOR",
                          "bookingType": "FULL_CONTAINER_LOAD",
                          "incoterm": "DAP",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          },
                          "containerCount": {
                            "reeferCount": {
                              "twentyFootContainerCount": 0,
                              "fortyFootContainerCount": 1,
                              "fortyFootHighCubeCount": 0
                            }
                          },
                          "accessorials": [
                            {
                              "code": "REFRIGERATED",
                              "details": {
                                "min": 32,
                                "max": 40,
                                "unit": "FAHRENHEIT"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Air Booking": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "SHIPMENT-12345"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "type": "PICKUP",
                          "arrivalDate": "2026-03-16",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "SXB"
                              },
                              {
                                "type": "AIRPORT_ICAO",
                                "value": "LFST"
                              }
                            ]
                          }
                        },
                        {
                          "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                          "type": "DELIVERY",
                          "arrivalDate": "2026-03-20",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "PVG"
                              },
                              {
                                "type": "AIRPORT_IATA",
                                "value": "ZSPD"
                              }
                            ]
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                          "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "FFW_SCAC",
                          "value": "ABCD"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.project44.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2092-12-01T08:30:00+00:00",
                        "routeSegmentIds": [
                          "c1816420-f5a7-4321-89e3-3a8a4acab734"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Chicken meat",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "apiConfiguration": {
                          "bookingWebhookName": "Shipper WebhookName"
                        },
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.project44.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "BOOKING_AGENT",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.project44.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "PORT_TO_PORT",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          }
                        }
                      }
                    ]
                  }
                },
                "Shipment Containing Air Booking - Exhaustive Payload": {
                  "description": "One may create a shipment with a booking immediately tied to it.",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "CR_1A2B3C4D"
                      }
                    ],
                    "routeInfo": {
                      "stops": [
                        {
                          "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "type": "PICKUP",
                          "arrivalDate": "2026-03-16",
                          "arrivalAppointmentWindow": {
                            "startTime": "10:15:00",
                            "endTime": "12:45:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "SXB"
                              },
                              {
                                "type": "AIRPORT_ICAO",
                                "value": "LFST"
                              }
                            ]
                          }
                        },
                        {
                          "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                          "type": "DELIVERY",
                          "arrivalDate": "2026-03-20",
                          "arrivalAppointmentWindow": {
                            "startTime": "15:15:00",
                            "endTime": "17:00:00"
                          },
                          "location": {
                            "identifiers": [
                              {
                                "type": "AIRPORT_IATA",
                                "value": "PVG"
                              },
                              {
                                "type": "AIRPORT_IATA",
                                "value": "ZSPD"
                              }
                            ]
                          }
                        }
                      ],
                      "routeSegments": [
                        {
                          "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                          "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                          "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "attribute name",
                        "values": [
                          "string value 1",
                          "string value 2"
                        ]
                      }
                    ],
                    "name": "shipmentName",
                    "notes": "shipmentNotes",
                    "bookings": [
                      {
                        "id": "ab64b61a-1d35-4716-a0c8-a32d50c0a9ec",
                        "shipmentId": "8421aacd-d92f-4b34-8d77-883bcd25e545",
                        "attributes": [
                          {
                            "name": "attribute name",
                            "values": [
                              "string value 1",
                              "string value 2"
                            ]
                          }
                        ],
                        "capacityProviderIdentifier": {
                          "type": "CARRIER_SCAC",
                          "value": "IPSH"
                        },
                        "carrierContacts": [
                          {
                            "companyName": "Carrier Company Name",
                            "givenName": "John",
                            "familyName": "Hudson",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.hudson@carrier-company.com"
                          }
                        ],
                        "totalRate": {
                          "currency": "USD",
                          "amount": 3500
                        },
                        "rateIdentifiers": [
                          {
                            "source": "EXTERNAL",
                            "type": "CONTRACT",
                            "value": "contract-1234"
                          }
                        ],
                        "expirationDateTime": "2026-03-11T08:30:00+00:00",
                        "routeSegmentIds": [
                          "c1816420-f5a7-4321-89e3-3a8a4acab734"
                        ],
                        "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                        "shipmentDetails": [
                          {
                            "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "handlingUnits": [
                              {
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 10,
                                "handlingUnitType": "PALLET",
                                "stackable": true,
                                "dimensions": {
                                  "length": 48,
                                  "width": 40,
                                  "height": 40,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 2750,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "description": "Custom accessories",
                                    "identifiers": [
                                      {
                                        "type": "SALES_ORDER",
                                        "value": "SO-1a2b3c"
                                      }
                                    ],
                                    "unitQuantity": 12,
                                    "unitType": "BOX"
                                  }
                                ]
                              }
                            ],
                            "description": "Temperature-Sensitive Goods",
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "1234"
                              }
                            ],
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ]
                          }
                        ],
                        "shipperContactInfo": {
                          "companyName": "Shipper Company Name",
                          "givenName": "Jennifer",
                          "familyName": "Smith",
                          "phoneNumber": "1223334445",
                          "mobilePhoneNumber": "1223334444",
                          "email": "j.smith@shipper-company.com"
                        },
                        "shippingDetails": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company Name",
                                "givenName": "Jennifer",
                                "familyName": "Smith",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "j.smith@shipper-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "400 Montgomery St",
                                  "2nd Floor"
                                ],
                                "postalCode": "94104",
                                "city": "San Francisco",
                                "state": "CA",
                                "country": "US"
                              },
                              "vatNumber": "vat-123"
                            },
                            {
                              "partyType": "BOOKING_AGENT",
                              "contactInfo": {
                                "companyName": "Notify Party Company Name",
                                "givenName": "Henry",
                                "familyName": "Jacobsen",
                                "phoneNumber": "1223334445",
                                "mobilePhoneNumber": "1223334444",
                                "email": "h.jacobsen@notify-company.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              },
                              "vatNumber": "vat-234"
                            }
                          ],
                          "serviceType": "PORT_TO_PORT",
                          "cargoMeasurements": {
                            "volume": {
                              "value": 480,
                              "unit": "CUBIC_FT"
                            },
                            "weight": {
                              "value": 2500,
                              "unit": "KG"
                            },
                            "dimensions": {
                              "length": 20,
                              "width": 6,
                              "height": 4,
                              "unit": "FT"
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookedShipment"
                },
                "examples": {
                  "Shipment Containing Truckload Booking - Full Response": {
                    "summary": "Shipment Containing Truckload Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "SHIPMENT-12345"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "type": "PICKUP",
                            "arrivalDate": "2092-12-10",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          },
                          {
                            "id": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                            "type": "DELIVERY",
                            "arrivalDate": "2092-12-12",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "3800 N Lamar Blvd",
                                  "Suite 210"
                                ],
                                "postalCode": "78756",
                                "city": "Austin",
                                "state": "TX",
                                "country": "US"
                              }
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                            "fromStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                            "toStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "DOT_NUMBER",
                            "value": "01234567"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.project44.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2092-12-01T08:30:00+00:00",
                          "routeSegmentIds": [
                            "57a01ada-d3a5-4072-a9b9-8f2c961371b0"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                              "deliveryStopId": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
                              "handlingUnits": [
                                {
                                  "description": "Chicken meat",
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "items": [
                                    {
                                      "description": "Chicken meat",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": "03968e4f-22fe-43ff-b76f-e77220456201"
                            }
                          ],
                          "apiConfiguration": {
                            "bookingWebhookName": "Shipper WebhookName"
                          },
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "shippingDetails": {
                            "loadPreference": "FULL",
                            "trailerType": "REFRIGERATED",
                            "trailerDetails": {
                              "refrigeratedClass": "CHILLED"
                            },
                            "trailerLength": {
                              "value": 52,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 2548,
                              "unit": "CUBIC_FT"
                            },
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 4,
                                  "max": 10,
                                  "unit": "CELSIUS"
                                }
                              }
                            ]
                          },
                          "id": "81b0523b-bcf6-421d-9da0-ebef5ad6de3b",
                          "status": "BOOKED",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "SHIPMENT-12345"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
                              "fromStop": {
                                "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              },
                              "toStop": {
                                "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              }
                            }
                          ],
                          "carrierResponseMethod": "EMAIL",
                          "bookingSourceMethod": "API",
                          "transportationMode": "TRUCKLOAD",
                          "masterShipmentId": "30fd2695-a419-4ecc-b18a-52a2e06bcaf5",
                          "carrierProvidedIdentifiers": [
                            {
                              "type": "BOOKING_NUMBER",
                              "value": "BN-1223334444"
                            },
                            {
                              "type": "DRIVER_MOBILE_PHONE_NUMBER",
                              "value": "5556667777"
                            }
                          ],
                          "capacityProviderReferenceKeys": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "createdDateTime": "2024-03-25T10:39:05",
                          "lastModifiedDateTime": "2024-03-25T10:39:05",
                          "lastAcceptedDateTime": "2024-03-25T10:39:05"
                        }
                      ],
                      "id": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
                      "createdDateTime": "2024-03-25T10:39:05",
                      "lastModifiedDateTime": "2024-03-25T10:39:05"
                    }
                  },
                  "Shipment Containing Ocean Booking - Full Response": {
                    "summary": "Shipment Containing Ocean Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "SHIPMENT-12345"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "type": "PICKUP",
                            "arrivalDate": "2092-12-10",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "222 W. Merchandise Mart Plaza",
                                  "Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          },
                          {
                            "id": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                            "type": "DELIVERY",
                            "arrivalDate": "2092-12-12",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "identifiers": [],
                              "address": {
                                "addressLines": [
                                  "3800 N Lamar Blvd",
                                  "Suite 210"
                                ],
                                "postalCode": "78756",
                                "city": "Austin",
                                "state": "TX",
                                "country": "US"
                              }
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                            "fromStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                            "toStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "9389da43-5f35-4ce5-94a5-7419c2b55580",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CODE"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.project44.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2092-12-01T08:30:00+00:00",
                          "routeSegmentIds": [
                            "5d1d83ed-a868-4f33-b1b0-eef390d0822b"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                              "deliveryStopId": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                              "handlingUnits": [
                                {
                                  "description": "Chicken meat",
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "items": [
                                    {
                                      "description": "Chicken meat",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": "54f7ab2b-c548-4e24-b9de-7bca4f05bba6"
                            }
                          ],
                          "apiConfiguration": {
                            "bookingWebhookName": "Shipper WebhookName"
                          },
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.project44.com"
                          },
                          "shippingDetails": {
                            "parties": [
                              {
                                "partyType": "SHIPPER",
                                "contactInfo": {
                                  "companyName": "Shipper Company Name",
                                  "givenName": "Jennifer",
                                  "familyName": "Smith",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "j.smith@shipper-company.project44.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "400 Montgomery St",
                                    "2nd Floor"
                                  ],
                                  "postalCode": "94104",
                                  "city": "San Francisco",
                                  "state": "CA",
                                  "country": "US"
                                },
                                "vatNumber": "vat-123"
                              },
                              {
                                "partyType": "NOTIFY_PARTY",
                                "contactInfo": {
                                  "companyName": "Notify Party Company Name",
                                  "givenName": "Henry",
                                  "familyName": "Jacobsen",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "h.jacobsen@notify-company.project44.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "222 W. Merchandise Mart Plaza",
                                    "Suite 1744"
                                  ],
                                  "postalCode": "60654",
                                  "city": "Chicago",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "vatNumber": "vat-234"
                              }
                            ],
                            "serviceType": "DOOR_TO_DOOR",
                            "bookingType": "FULL_CONTAINER_LOAD",
                            "incoterm": "DAP",
                            "cargoMeasurements": {
                              "volume": {
                                "value": 480,
                                "unit": "CUBIC_FT"
                              },
                              "weight": {
                                "value": 2500,
                                "unit": "KG"
                              },
                              "dimensions": {
                                "length": 20,
                                "width": 6,
                                "height": 4,
                                "unit": "FT"
                              }
                            },
                            "containerCount": {
                              "reeferCount": {
                                "twentyFootContainerCount": 0,
                                "fortyFootContainerCount": 1,
                                "fortyFootHighCubeCount": 0
                              }
                            },
                            "accessorials": [
                              {
                                "code": "REFRIGERATED",
                                "details": {
                                  "min": 32,
                                  "max": 40,
                                  "unit": "FAHRENHEIT"
                                }
                              }
                            ],
                            "portsDetails": [
                              [
                                {
                                  "portType": "PORT_OF_LOADING",
                                  "estimatedDatetime": "2092-07-12T16:00:00+00:00"
                                }
                              ]
                            ],
                            "estimatedFinalDestinationDatetime": "2092-07-14T16:00:00",
                            "cutOffDetails": {
                              "cutOffDatetime": "2092-07-09T16:00:00+00:00",
                              "vesselCutOffDatetime": "2092-07-11T16:00:00",
                              "documentationCutOffDatetime": "2092-07-11T16:00:00"
                            },
                            "containerDetails": [
                              {
                                "containerId": "BMOU5100160",
                                "referenceKeys": [
                                  {
                                    "name": "attribute name",
                                    "values": [
                                      "string value 1",
                                      "string value 2"
                                    ]
                                  }
                                ]
                              }
                            ]
                          },
                          "id": "88da97f8-d62e-449e-9bc5-00846522b1bc",
                          "status": "BOOKED",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "SHIPMENT-12345"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "5d1d83ed-a868-4f33-b1b0-eef390d0822b",
                              "fromStop": {
                                "id": "c4e7f3f5-d939-4c7e-ba1e-cdaa4cb0b800",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              },
                              "toStop": {
                                "id": "265a95e9-de8f-4a32-ae7e-b11c048d8eb3",
                                "type": "PICKUP",
                                "arrivalDate": "2092-12-10",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "identifiers": [],
                                  "address": {
                                    "addressLines": [
                                      "222 W. Merchandise Mart Plaza",
                                      "Suite 1744"
                                    ],
                                    "postalCode": "60654",
                                    "city": "Chicago",
                                    "state": "IL",
                                    "country": "US"
                                  }
                                }
                              }
                            }
                          ],
                          "carrierResponseMethod": "EDI",
                          "bookingSourceMethod": "API",
                          "transportationMode": "OCEAN",
                          "masterShipmentId": "4b0e8fef-9df7-4e5c-b55f-3144a35da7c9",
                          "carrierProvidedIdentifiers": [
                            {
                              "type": "BOOKING_NUMBER",
                              "value": "BN-1223334444"
                            },
                            {
                              "type": "CARRIER_NAME",
                              "value": "EON Ltd."
                            },
                            {
                              "type": "CARRIER_SCAC",
                              "value": "ELTD"
                            },
                            {
                              "type": "VESSEL_NAME",
                              "value": "Infinity"
                            },
                            {
                              "type": "VOYAGE_NUMBER",
                              "value": "117"
                            }
                          ],
                          "capacityProviderReferenceKeys": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "createdDateTime": "2024-03-25T10:39:05",
                          "lastModifiedDateTime": "2024-03-25T10:39:05",
                          "lastAcceptedDateTime": "2024-03-25T10:39:05"
                        }
                      ],
                      "id": "9389da43-5f35-4ce5-94a5-7419c2b55580",
                      "createdDateTime": "2024-03-25T10:39:05",
                      "lastModifiedDateTime": "2024-03-25T10:39:05"
                    }
                  },
                  "Shipment Containing Air Booking - Full Response": {
                    "summary": "Shipment Containing Air Booking - Full Response",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "CR_1A2B3C4D"
                        }
                      ],
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "type": "PICKUP",
                            "arrivalDate": "2026-03-16",
                            "arrivalAppointmentWindow": {
                              "startTime": "10:15:00",
                              "endTime": "12:45:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "id": "32b27c58-91bc-4bbe-89c8-f1ed6fe80449",
                              "name": null,
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "SXB"
                                },
                                {
                                  "type": "AIRPORT_ICAO",
                                  "value": "LFST"
                                }
                              ],
                              "address": null,
                              "geoCoordinates": null
                            }
                          },
                          {
                            "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                            "type": "DELIVERY",
                            "arrivalDate": "2026-03-20",
                            "arrivalAppointmentWindow": {
                              "startTime": "15:15:00",
                              "endTime": "17:00:00"
                            },
                            "contacts": [],
                            "accessorials": [],
                            "location": {
                              "id": "06a8e6f3-a049-4da3-9948-597a73b3a367",
                              "name": null,
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "PVG"
                                },
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "ZSPD"
                                }
                              ],
                              "address": null,
                              "geoCoordinates": null
                            }
                          }
                        ],
                        "routeSegments": [
                          {
                            "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                            "fromStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                            "toStopId": "a4621429-0389-4b12-bf16-c7811d8721a8"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "attribute name",
                          "values": [
                            "string value 1",
                            "string value 2"
                          ]
                        }
                      ],
                      "name": "shipmentName",
                      "notes": "shipmentNotes",
                      "bookings": [
                        {
                          "shipmentId": "3aedc920-e008-41c8-9221-60a6a1844d9e",
                          "attributes": [
                            {
                              "name": "attribute name",
                              "values": [
                                "string value 1",
                                "string value 2"
                              ]
                            }
                          ],
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "IPSH"
                          },
                          "carrierContacts": [
                            {
                              "companyName": "Carrier Company Name",
                              "givenName": "John",
                              "familyName": "Hudson",
                              "phoneNumber": "1223334445",
                              "mobilePhoneNumber": "1223334444",
                              "email": "j.hudson@carrier-company.com"
                            }
                          ],
                          "totalRate": {
                            "currency": "USD",
                            "amount": 3500
                          },
                          "rateIdentifiers": [
                            {
                              "source": "EXTERNAL",
                              "type": "CONTRACT",
                              "value": "contract-1234"
                            }
                          ],
                          "expirationDateTime": "2026-03-11T08:30:00+00:00",
                          "routeSegmentIds": [
                            "c1816420-f5a7-4321-89e3-3a8a4acab734"
                          ],
                          "notes": "Hello carrier! This is a note from the shipper, visible to you.",
                          "shipmentDetails": [
                            {
                              "pickupStopId": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                              "deliveryStopId": "a4621429-0389-4b12-bf16-c7811d8721a8",
                              "handlingUnits": [
                                {
                                  "description": null,
                                  "freightClass": null,
                                  "monetaryValue": {
                                    "currency": "USD",
                                    "amount": 1200
                                  },
                                  "quantity": 10,
                                  "handlingUnitType": "PALLET",
                                  "stackable": true,
                                  "dimensions": {
                                    "length": 48,
                                    "width": 40,
                                    "height": 40,
                                    "unit": "IN"
                                  },
                                  "weight": {
                                    "value": 2750,
                                    "unit": "LB"
                                  },
                                  "nmfcItemCode": null,
                                  "nmfcSubCode": null,
                                  "hazmatDetail": null,
                                  "items": [
                                    {
                                      "description": "Custom accessories",
                                      "identifiers": [
                                        {
                                          "type": "SALES_ORDER",
                                          "value": "SO-1a2b3c"
                                        }
                                      ],
                                      "unitQuantity": 12,
                                      "unitType": "BOX"
                                    }
                                  ]
                                }
                              ],
                              "items": [],
                              "description": "Temperature-Sensitive Goods",
                              "identifiers": [
                                {
                                  "type": "PURCHASE_ORDER",
                                  "value": "1234"
                                }
                              ],
                              "accessorials": [
                                {
                                  "code": "REFRIGERATED",
                                  "details": {
                                    "min": 32,
                                    "max": 40,
                                    "unit": "FAHRENHEIT"
                                  }
                                }
                              ],
                              "loadId": null
                            }
                          ],
                          "apiConfiguration": null,
                          "shipperContactInfo": {
                            "companyName": "Shipper Company Name",
                            "givenName": "Jennifer",
                            "familyName": "Smith",
                            "phoneNumber": "1223334445",
                            "mobilePhoneNumber": "1223334444",
                            "email": "j.smith@shipper-company.com"
                          },
                          "shippingDetails": {
                            "parties": [
                              {
                                "partyType": "SHIPPER",
                                "contactInfo": {
                                  "companyName": "Shipper Company Name",
                                  "givenName": "Jennifer",
                                  "familyName": "Smith",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "j.smith@shipper-company.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "400 Montgomery St",
                                    "2nd Floor"
                                  ],
                                  "postalCode": "94104",
                                  "city": "San Francisco",
                                  "state": "CA",
                                  "country": "US"
                                },
                                "locationIdentifiers": null,
                                "vatNumber": "vat-123",
                                "identifyingCodes": null
                              },
                              {
                                "partyType": "BOOKING_AGENT",
                                "contactInfo": {
                                  "companyName": "Notify Party Company Name",
                                  "givenName": "Henry",
                                  "familyName": "Jacobsen",
                                  "phoneNumber": "1223334445",
                                  "mobilePhoneNumber": "1223334444",
                                  "email": "h.jacobsen@notify-company.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "222 W. Merchandise Mart Plaza",
                                    "Suite 1744"
                                  ],
                                  "postalCode": "60654",
                                  "city": "Chicago",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "locationIdentifiers": null,
                                "vatNumber": "vat-234",
                                "identifyingCodes": null
                              }
                            ],
                            "serviceType": "PORT_TO_PORT",
                            "incoterm": null,
                            "cargoMeasurements": {
                              "volume": {
                                "value": 480,
                                "unit": "CUBIC_FT"
                              },
                              "weight": {
                                "value": 2500,
                                "unit": "KG"
                              },
                              "dimensions": {
                                "length": 20,
                                "width": 6,
                                "height": 4,
                                "unit": "FT"
                              }
                            },
                            "accessorials": [],
                            "airportDetails": [],
                            "estimatedFinalDestinationDateTime": null
                          },
                          "bookingIdentifiers": [],
                          "rateRequestId": null,
                          "quoteId": null,
                          "id": "a79666f8-26fd-414e-af7d-d7de6fe2106a",
                          "status": "PROCESSING",
                          "shipmentIdentifiers": [
                            {
                              "type": "CUSTOMER_REFERENCE",
                              "value": "CR_1A2B3C4D"
                            }
                          ],
                          "routeSegments": [
                            {
                              "id": "c1816420-f5a7-4321-89e3-3a8a4acab734",
                              "fromStop": {
                                "id": "62f54187-6379-42c4-ab02-7fcb2ca09f30",
                                "type": "PICKUP",
                                "arrivalDate": "2026-03-16",
                                "arrivalAppointmentWindow": {
                                  "startTime": "10:15:00",
                                  "endTime": "12:45:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "id": "32b27c58-91bc-4bbe-89c8-f1ed6fe80449",
                                  "name": null,
                                  "identifiers": [
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "SXB"
                                    },
                                    {
                                      "type": "AIRPORT_ICAO",
                                      "value": "LFST"
                                    }
                                  ],
                                  "address": null,
                                  "geoCoordinates": null
                                }
                              },
                              "toStop": {
                                "id": "a4621429-0389-4b12-bf16-c7811d8721a8",
                                "type": "DELIVERY",
                                "arrivalDate": "2026-03-20",
                                "arrivalAppointmentWindow": {
                                  "startTime": "15:15:00",
                                  "endTime": "17:00:00"
                                },
                                "contacts": [],
                                "accessorials": [],
                                "location": {
                                  "id": "06a8e6f3-a049-4da3-9948-597a73b3a367",
                                  "name": null,
                                  "identifiers": [
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "PVG"
                                    },
                                    {
                                      "type": "AIRPORT_IATA",
                                      "value": "ZSPD"
                                    }
                                  ],
                                  "address": null,
                                  "geoCoordinates": null
                                }
                              }
                            }
                          ],
                          "rejectionReason": null,
                          "carrierResponseMethod": "API",
                          "automatedFailureReason": null,
                          "bookingSourceMethod": "API",
                          "carrierRejectionNotes": null,
                          "transportationMode": "AIR",
                          "masterShipmentId": null,
                          "carrierProvidedIdentifiers": [],
                          "capacityProviderReferenceKeys": [],
                          "createdDateTime": "2026-03-09T15:46:23",
                          "lastModifiedDateTime": "2026-03-09T15:46:23",
                          "lastAcceptedDateTime": null,
                          "rejectedDateTime": null,
                          "cancelledDateTime": null
                        }
                      ],
                      "id": "3aedc920-e008-41c8-9221-60a6a1844d9e",
                      "createdDateTime": "2026-03-09T15:46:23",
                      "lastModifiedDateTime": "2026-03-09T15:46:23"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/booking/v1/shipments/{shipmentId}/bookings/cancellations": {
      "post": {
        "tags": [
          "Multi-Modal: Booking"
        ],
        "summary": "Cancel All Bookings For Shipment",
        "description": "As a shipper, change the status of all related and eligible bookings to `CANCELLED`.",
        "operationId": "cancel_all_bookings_for_shipment_shipments__shipmentId__bookings_cancellations_post",
        "parameters": [
          {
            "description": "The project44-generated shipment identifier",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The project44-generated shipment identifier",
              "format": "uuid"
            },
            "name": "shipmentId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookedShipment"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/document/v1/documents": {
      "post": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Create Document",
        "description": "Create a document",
        "operationId": "create_document_documents_post",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/Body_create_document_documents_post"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/document/v1/documents/{documentId}": {
      "get": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Get Document",
        "description": "Get a document by ID",
        "operationId": "get_document_documents__documentId__get",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "name": "documentId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "put": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Put Document",
        "description": "Update a document",
        "operationId": "put_document_documents__documentId__put",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "name": "documentId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUpdateDocument"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "delete": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Delete Document",
        "description": "Delete a document",
        "operationId": "delete_document_documents__documentId__delete",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "name": "documentId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "patch": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Patch Document",
        "description": "Update a document",
        "operationId": "patch_document_documents__documentId__patch",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "name": "documentId",
            "in": "path"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PatchDocument"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/document/v1/documents/search": {
      "post": {
        "tags": [
          "Multi-Modal: Document"
        ],
        "summary": "Search Documents",
        "description": "Get documents",
        "operationId": "search_documents_documents_search_post",
        "parameters": [
          {
            "required": false,
            "schema": {
              "minimum": 1,
              "type": "integer",
              "default": 1
            },
            "name": "page",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "maximum": 500,
              "minimum": 1,
              "type": "integer",
              "default": 10
            },
            "name": "size",
            "in": "query"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Body_search_documents_documents_search_post"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/invitation/v1/invitations": {
      "get": {
        "tags": [
          "Invitations"
        ],
        "summary": "Get invitations matching a criteria",
        "description": "Get invitations request allows users to fetch a list of invitations sent to entities to join your network. This request is useful for monitoring the status of the invitations and understanding the relationships formed within the network. By providing specific query parameters, users can filter the results based on the invitee's identifier type, value, and the capability for which the invitations were created.\n",
        "operationId": "getInvitationsRequest",
        "parameters": [
          {
            "name": "inviteeIdentifier.type",
            "in": "query",
            "description": "Type of invitee identifier",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "VAT",
                "SCAC",
                "DOT_NUMBER",
                "MC_NUMBER",
                "P44_EU"
              ]
            }
          },
          {
            "name": "inviteeIdentifier.value",
            "in": "query",
            "description": "Value of invitee identifier",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "capability",
            "in": "query",
            "description": "The capability for which the invitations where created",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "TRUCKLOAD_ASSET_TRACKING"
              ]
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Page number for pagination. min: 1, max: 25",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Page size for pagination. min: 1, max: 25",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of invitations matching the criteria",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvitationPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. Malformed or an invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      },
      "post": {
        "tags": [
          "Invitations"
        ],
        "summary": "Invite an entity to join your network.",
        "description": "Create a new invitation for an entity to join your network and provide a requested capability. If an entity identified by the inviteeIdentifiers does not exist in the project44 platform, include relevant contact information for the platform to invite an entity to project44.\n When an invitation is accepted, a network relationship is formed between the inviter and the invitee.\n",
        "operationId": "createInvitationRequest",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Invitation"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Invitation created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. Malformed or an invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Entity not found and no contact information was provided",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "409": {
            "description": "In progress invitation to an entity already exists",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/rating/v1/rate-requests": {
      "post": {
        "tags": [
          "Multi-Modal: Rating"
        ],
        "summary": "Post Rate Request",
        "operationId": "post_rate_request_rate_requests_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RateRequestQuery"
              },
              "examples": {
                "OTR request": {
                  "summary": "OTR Rate Request Query",
                  "description": "OTR Rate Request Query",
                  "value": {
                    "rateDetail": {
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "type": "PICKUP",
                            "location": {
                              "name": "Rockford Warehouse - Waldom Electronics",
                              "address": {
                                "addressLines": [
                                  "1804 Morgan St"
                                ],
                                "postalCode": "61102",
                                "city": "Rockford",
                                "state": "IL",
                                "country": "US"
                              },
                              "timeZone": "America/Chicago"
                            },
                            "contacts": [
                              {
                                "givenName": "Erik Nystrom",
                                "email": "erik@waldom.com",
                                "phoneNumber": "+1 815-564-4555",
                                "companyName": "Waldom Electronics"
                              }
                            ]
                          },
                          {
                            "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "type": "DELIVERY",
                            "location": {
                              "name": "Online Components",
                              "address": {
                                "addressLines": [
                                  "2425 S 21st St"
                                ],
                                "postalCode": "85034",
                                "city": "Phoenix",
                                "state": "AZ",
                                "country": "US"
                              },
                              "timeZone": "America/Phoenix"
                            },
                            "contacts": [
                              {
                                "givenName": "Norma Pomering",
                                "email": "norma@onlinecomponents.com",
                                "phoneNumber": "+1 546-645-4354",
                                "companyName": "Online Components"
                              }
                            ]
                          }
                        ],
                        "routeSegments": [
                          {
                            "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                          }
                        ]
                      },
                      "shippingDetails": {
                        "truck": {
                          "loadPreference": "FULL",
                          "trailerType": "DRY_VAN",
                          "trailerLength": {
                            "value": 53,
                            "unit": "FT"
                          },
                          "trailerVolume": {
                            "value": 0,
                            "unit": "CUBIC_FT"
                          }
                        },
                        "ltl": {
                          "capacityProviderAccountGroup": {
                            "code": "Default",
                            "accounts": []
                          }
                        }
                      },
                      "shipmentDetails": [
                        {
                          "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                          "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                          "handlingUnits": [
                            {
                              "description": "Electronics",
                              "freightClass": "50",
                              "monetaryValue": {
                                "amount": 20000,
                                "currency": "USD"
                              },
                              "quantity": 12,
                              "handlingUnitType": "PALLET",
                              "stackable": false,
                              "dimensions": {
                                "length": 48,
                                "width": 48,
                                "height": 48,
                                "unit": "IN"
                              },
                              "weight": {
                                "unit": "LB",
                                "value": 5000
                              },
                              "items": [
                                {}
                              ]
                            }
                          ],
                          "identifiers": [
                            {
                              "type": "UNKNOWN",
                              "value": "UNKNOWN"
                            }
                          ]
                        }
                      ],
                      "pickupDate": "2025-05-26",
                      "shipperContactInfo": {
                        "givenName": "John",
                        "familyName": "Smith",
                        "email": "john.smith@shipper.com",
                        "phoneNumber": "+12233344445",
                        "mobilePhoneNumber": "+12233344445",
                        "companyName": "Shipper Co."
                      }
                    },
                    "expirationDateTime": "2025-05-21T18:11:15.585Z"
                  }
                },
                "FTL request": {
                  "summary": "FTL Rate Request Query",
                  "description": "FTL Rate Request Query",
                  "value": {
                    "identifiers": [
                      {
                        "type": "CUSTOMER_REFERENCE",
                        "value": "CR_123456"
                      }
                    ],
                    "attributes": [
                      {
                        "name": "TRANSACTION_NO",
                        "values": [
                          "1383272937"
                        ]
                      }
                    ],
                    "rateDetail": {
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "type": "PICKUP",
                            "location": {
                              "name": "Rockford Warehouse - Waldom Electronics",
                              "address": {
                                "addressLines": [
                                  "1804 Morgan St"
                                ],
                                "postalCode": "61102",
                                "city": "Rockford",
                                "state": "IL",
                                "country": "US"
                              },
                              "timeZone": "America/Chicago"
                            },
                            "contacts": [
                              {
                                "givenName": "Erik Nystrom",
                                "email": "erik@waldom.com",
                                "phoneNumber": "+1 815-564-4555",
                                "companyName": "Waldom Electronics"
                              }
                            ]
                          },
                          {
                            "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "type": "DELIVERY",
                            "location": {
                              "name": "Online Components",
                              "address": {
                                "addressLines": [
                                  "2425 S 21st St"
                                ],
                                "postalCode": "85034",
                                "city": "Phoenix",
                                "state": "AZ",
                                "country": "US"
                              },
                              "timeZone": "America/Phoenix"
                            },
                            "contacts": [
                              {
                                "givenName": "Norma Pomering",
                                "email": "norma@onlinecomponents.com",
                                "phoneNumber": "+1 546-645-4354",
                                "companyName": "Online Components"
                              }
                            ]
                          }
                        ],
                        "routeSegments": [
                          {
                            "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                          }
                        ]
                      },
                      "attributes": [
                        {
                          "name": "DELIVERY_CONTACT",
                          "values": [
                            "John Doe, john.doe@test.com"
                          ]
                        }
                      ],
                      "shippingDetails": {
                        "truck": {
                          "loadPreference": "FULL",
                          "trailerType": "DRY_VAN",
                          "trailerLength": {
                            "value": 53,
                            "unit": "FT"
                          },
                          "trailerVolume": {
                            "value": 0,
                            "unit": "CUBIC_FT"
                          }
                        }
                      },
                      "shipmentDetails": [
                        {
                          "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                          "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                          "handlingUnits": [
                            {
                              "description": "Electronics",
                              "freightClass": "50",
                              "monetaryValue": {
                                "amount": 20000,
                                "currency": "USD"
                              },
                              "quantity": 12,
                              "handlingUnitType": "PALLET",
                              "stackable": false,
                              "dimensions": {
                                "length": 48,
                                "width": 48,
                                "height": 48,
                                "unit": "IN"
                              },
                              "weight": {
                                "unit": "LB",
                                "value": 5000
                              },
                              "items": [
                                {}
                              ]
                            }
                          ],
                          "identifiers": [
                            {
                              "type": "UNKNOWN",
                              "value": "UNKNOWN"
                            }
                          ]
                        }
                      ],
                      "pickupDate": "2025-05-26",
                      "shipperContactInfo": {
                        "givenName": "John",
                        "familyName": "Smith",
                        "email": "john.smith@shipper.com",
                        "phoneNumber": "+12233344445",
                        "mobilePhoneNumber": "+12233344445",
                        "companyName": "Shipper Co."
                      },
                      "distanceToTravel": {
                        "value": "1750",
                        "unit": "MI"
                      }
                    },
                    "name": "Rockford - Phoenix",
                    "expirationDateTime": "2025-05-21T18:11:15.585Z"
                  }
                },
                "AIR request": {
                  "summary": "AIR Rate Request Query",
                  "description": "AIR Rate Request Query",
                  "value": {
                    "rateDetail": {
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "type": "PORT_OF_LOADING",
                            "location": {
                              "name": "Tuluksak Airport",
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "TLT"
                                }
                              ],
                              "timeZone": "America/Anchorage"
                            },
                            "contacts": []
                          },
                          {
                            "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "type": "PORT_OF_DISCHARGE",
                            "location": {
                              "name": "Newcastle Airport",
                              "identifiers": [
                                {
                                  "type": "AIRPORT_IATA",
                                  "value": "NTL"
                                },
                                {
                                  "type": "AIRPORT_ICAO",
                                  "value": "YWLM"
                                }
                              ],
                              "timeZone": "Australia/Sydney"
                            },
                            "contacts": []
                          }
                        ],
                        "routeSegments": [
                          {
                            "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                          }
                        ]
                      },
                      "shippingDetails": {
                        "air": {
                          "serviceType": "PORT_TO_PORT"
                        }
                      },
                      "shipmentDetails": [
                        {
                          "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                          "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                          "handlingUnits": [
                            {
                              "description": "Electronics",
                              "monetaryValue": {
                                "currency": "USD",
                                "amount": 1200
                              },
                              "quantity": 2,
                              "handlingUnitType": "PALLET",
                              "stackable": false,
                              "dimensions": {
                                "length": 12,
                                "width": 44,
                                "height": 22,
                                "unit": "FT"
                              },
                              "weight": {
                                "value": 322,
                                "unit": "LB"
                              }
                            }
                          ],
                          "identifiers": [
                            {
                              "type": "PURCHASE_ORDER",
                              "value": "PO_123"
                            }
                          ]
                        }
                      ],
                      "pickupDate": "2025-11-18",
                      "shipperContactInfo": {
                        "email": "test1@shipperco.com",
                        "companyName": "Shipper Co."
                      }
                    },
                    "name": "Tuluksak Airport-Newcastle Airport",
                    "expirationDateTime": "2025-11-07T09:03:37.585Z"
                  }
                },
                "OCEAN request": {
                  "summary": "OCEAN Rate Request Query",
                  "description": "OCEAN Rate Request Query",
                  "value": {
                    "rateDetail": {
                      "routeInfo": {
                        "stops": [
                          {
                            "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "type": "PORT_OF_LOADING",
                            "location": {
                              "name": "Shanghai",
                              "identifiers": [
                                {
                                  "type": "PORT_UN_LOCODE",
                                  "value": "CNSHA"
                                }
                              ],
                              "timeZone": "Asia/Shanghai"
                            },
                            "contacts": []
                          },
                          {
                            "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "type": "PORT_OF_DISCHARGE",
                            "location": {
                              "name": "Long Beach",
                              "identifiers": [
                                {
                                  "type": "PORT_UN_LOCODE",
                                  "value": "USLGB"
                                }
                              ],
                              "timeZone": "America/Los_Angeles"
                            },
                            "contacts": []
                          }
                        ],
                        "routeSegments": [
                          {
                            "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                          }
                        ]
                      },
                      "shippingDetails": {
                        "ocean": {
                          "parties": [
                            {
                              "partyType": "SHIPPER",
                              "contactInfo": {
                                "companyName": "Shipper Company",
                                "givenName": "John",
                                "phoneNumber": "+213424566777",
                                "email": "jsmith@fmail.com"
                              },
                              "addressInfo": {
                                "addressLines": [
                                  "222 Merchandise Mart Plz, Suite 1744"
                                ],
                                "postalCode": "60654",
                                "city": "Chicago",
                                "state": "IL",
                                "country": "US"
                              }
                            }
                          ],
                          "incoterm": "CPT",
                          "serviceType": "CONTAINER_YARD_TO_CONTAINER_YARD",
                          "bookingType": "FULL_CONTAINER_LOAD",
                          "containerCount": {
                            "dryCargoCount": {
                              "fortyFootContainerCount": 1
                            }
                          }
                        }
                      },
                      "shipmentDetails": [
                        {
                          "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                          "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                          "handlingUnits": [
                            {
                              "description": "Electronics",
                              "freightClass": "50",
                              "monetaryValue": {
                                "amount": 20000,
                                "currency": "USD"
                              },
                              "quantity": 12,
                              "handlingUnitType": "PALLET",
                              "stackable": false,
                              "dimensions": {
                                "length": 48,
                                "width": 48,
                                "height": 48,
                                "unit": "IN"
                              },
                              "weight": {
                                "unit": "LB",
                                "value": 5000
                              },
                              "items": [
                                {}
                              ]
                            }
                          ],
                          "identifiers": [
                            {
                              "type": "PURCHASE_ORDER",
                              "value": "PO_123"
                            }
                          ]
                        }
                      ],
                      "pickupDate": "2025-05-26",
                      "shipperContactInfo": {
                        "email": "test@shipperco.com",
                        "companyName": "Shipper Co."
                      }
                    },
                    "name": "Shanghai - Long Beach",
                    "expirationDateTime": "2025-05-21T18:11:15.585Z"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateRequest"
                },
                "examples": {
                  "OTR Response": {
                    "summary": "OTR Response with FTL and LTL quotes",
                    "value": {
                      "rateDetail": {
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PICKUP",
                              "location": {
                                "name": "Rockford Warehouse - Waldom Electronics",
                                "address": {
                                  "addressLines": [
                                    "1804 Morgan St"
                                  ],
                                  "postalCode": "61102",
                                  "city": "Rockford",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "timeZone": "America/Chicago",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Erik Nystrom",
                                  "email": "erik@waldom.com",
                                  "phoneNumber": "+1 815-564-4555",
                                  "companyName": "Waldom Electronics"
                                }
                              ]
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "DELIVERY",
                              "location": {
                                "name": "Online Components",
                                "address": {
                                  "addressLines": [
                                    "2425 S 21st St"
                                  ],
                                  "postalCode": "85034",
                                  "city": "Phoenix",
                                  "state": "AZ",
                                  "country": "US"
                                },
                                "timeZone": "America/Phoenix",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Norma Pomering",
                                  "email": "norma@onlinecomponents.com",
                                  "phoneNumber": "+1 546-645-4354",
                                  "companyName": "Online Components"
                                }
                              ]
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                            }
                          ]
                        },
                        "shippingDetails": {
                          "truck": {
                            "loadPreference": "FULL",
                            "trailerType": "DRY_VAN",
                            "trailerLength": {
                              "value": 53,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 0,
                              "unit": "CUBIC_FT"
                            }
                          },
                          "ltl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            }
                          },
                          "volumeLtl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            },
                            "totalLinearFeet": 24
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "freightClass": "50",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 20000
                                },
                                "quantity": 12,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 48,
                                  "width": 48,
                                  "height": 48,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 5000,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "identifiers": []
                                  }
                                ]
                              }
                            ],
                            "items": [],
                            "identifiers": [
                              {
                                "type": "UNKNOWN",
                                "value": "UNKNOWN"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-05-26",
                        "shipperContactInfo": {
                          "givenName": "John",
                          "familyName": "Smith",
                          "email": "john.smith@shipper.com",
                          "phoneNumber": "+12233344445",
                          "mobilePhoneNumber": "+12233344445",
                          "companyName": "Shipper Co."
                        }
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Rockford - Phoenix",
                      "expirationDateTime": "2025-05-21T18:11:15.585000+00:00",
                      "id": "df60c107-b6d8-46a4-9bb0-7441a59a6f5e",
                      "quotes": [
                        {
                          "id": "5252d6e7-2f55-4998-89db-daf10fd21101",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 3550.79,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "GTJN"
                          },
                          "capacityProviderName": "Go2 Logistics",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        },
                        {
                          "id": "25062bd0-b7fc-41f6-9aab-8f327af65851",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3160.18,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P449"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "4ed16919-08c5-4ce3-8d81-cea6b2bd91c4",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3122,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P446"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "9c08e849-ee91-421f-9f5d-c255e82c58b0",
                          "status": "CANCELLED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "FZMK"
                          },
                          "capacityProviderName": "Fitzmark LLC",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "fb9654f7-7764-486d-ad38-b90f855a5a0d",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 6505.39,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "RLCA"
                          },
                          "capacityProviderName": "R & L CARRIERS",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "ee0402f1-fbe2-4fa6-9ff1-217220dba6ae",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 3219.08,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "RDTF"
                          },
                          "capacityProviderName": "ROADTEX TRANSPORTATION CORP",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "cb150ffb-7664-4b85-9f22-1722a20d36c0",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 1031.45,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CTII"
                          },
                          "capacityProviderName": "CENTRAL TRANSPORT LLC",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        }
                      ],
                      "marketQuotes": [
                        {
                          "id": "4cd6c22c-6c37-4872-a5c0-e4a02e22683f",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 2874,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "SONAR"
                          },
                          "capacityProviderName": "SONAR",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        }
                      ],
                      "createdDateTime": "2025-05-22T10:12:42.500050",
                      "lastModifiedDateTime": "2025-05-22T10:12:42.921013",
                      "status": "QUOTES_REQUESTED",
                      "ratingSourceMethod": "API"
                    }
                  },
                  "FTL Response": {
                    "summary": "FTL Response with quotes",
                    "value": {
                      "identifiers": [
                        {
                          "type": "CUSTOMER_REFERENCE",
                          "value": "CR_123456"
                        }
                      ],
                      "attributes": [
                        {
                          "name": "TRANSACTION_NO",
                          "values": [
                            "1383272937"
                          ]
                        }
                      ],
                      "rateDetail": {
                        "attributes": [
                          {
                            "name": "DELIVERY_CONTACT",
                            "values": [
                              "John Doe, john.doe@test.com"
                            ]
                          }
                        ],
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PICKUP",
                              "location": {
                                "name": "Rockford Warehouse - Waldom Electronics",
                                "address": {
                                  "addressLines": [
                                    "1804 Morgan St"
                                  ],
                                  "postalCode": "61102",
                                  "city": "Rockford",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "timeZone": "America/Chicago",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Erik Nystrom",
                                  "email": "erik@waldom.com",
                                  "phoneNumber": "+1 815-564-4555",
                                  "companyName": "Waldom Electronics"
                                }
                              ]
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "DELIVERY",
                              "location": {
                                "name": "Online Components",
                                "address": {
                                  "addressLines": [
                                    "2425 S 21st St"
                                  ],
                                  "postalCode": "85034",
                                  "city": "Phoenix",
                                  "state": "AZ",
                                  "country": "US"
                                },
                                "timeZone": "America/Phoenix",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Norma Pomering",
                                  "email": "norma@onlinecomponents.com",
                                  "phoneNumber": "+1 546-645-4354",
                                  "companyName": "Online Components"
                                }
                              ]
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                            }
                          ]
                        },
                        "shippingDetails": {
                          "truck": {
                            "loadPreference": "FULL",
                            "trailerType": "DRY_VAN",
                            "trailerLength": {
                              "value": 53,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 0,
                              "unit": "CUBIC_FT"
                            }
                          },
                          "ltl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            }
                          },
                          "volumeLtl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            },
                            "totalLinearFeet": 24
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "freightClass": "50",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 20000
                                },
                                "quantity": 12,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 48,
                                  "width": 48,
                                  "height": 48,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 5000,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "identifiers": []
                                  }
                                ]
                              }
                            ],
                            "items": [],
                            "identifiers": [
                              {
                                "type": "UNKNOWN",
                                "value": "UNKNOWN"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-05-26",
                        "shipperContactInfo": {
                          "givenName": "John",
                          "familyName": "Smith",
                          "email": "john.smith@shipper.com",
                          "phoneNumber": "+12233344445",
                          "mobilePhoneNumber": "+12233344445",
                          "companyName": "Shipper Co."
                        }
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Rockford - Phoenix",
                      "expirationDateTime": "2025-05-21T18:11:15.585000+00:00",
                      "id": "df60c107-b6d8-46a4-9bb0-7441a59a6f5e",
                      "marketQuotes": [
                        {
                          "id": "4cd6c22c-6c37-4872-a5c0-e4a02e22683f",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 2874,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "SONAR"
                          },
                          "capacityProviderName": "SONAR",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        }
                      ],
                      "createdDateTime": "2025-05-22T10:12:42.500050",
                      "lastModifiedDateTime": "2025-05-22T10:12:42.921013",
                      "status": "QUOTES_REQUESTED",
                      "ratingSourceMethod": "API",
                      "quotes": [
                        {
                          "id": "5252d6e7-2f55-4998-89db-daf10fd21101",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 3550.79,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "GTJN"
                          },
                          "capacityProviderName": "Go2 Logistics",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        },
                        {
                          "id": "25062bd0-b7fc-41f6-9aab-8f327af65851",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3160.18,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P449"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "4ed16919-08c5-4ce3-8d81-cea6b2bd91c4",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3122,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P446"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "9c08e849-ee91-421f-9f5d-c255e82c58b0",
                          "status": "CANCELLED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "FZMK"
                          },
                          "capacityProviderName": "Fitzmark LLC",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        }
                      ]
                    }
                  },
                  "AIR Response": {
                    "summary": "AIR Response with quotes",
                    "value": {
                      "identifiers": [],
                      "attributes": [],
                      "rateDetail": {
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PORT_OF_LOADING",
                              "location": {
                                "name": "Tuluksak Airport",
                                "address": {
                                  "addressLines": [
                                    "Tuluksak Airport"
                                  ],
                                  "city": "Tuluksak",
                                  "state": "Alaska",
                                  "country": "US"
                                },
                                "timeZone": "America/Anchorage",
                                "geoCoordinates": {
                                  "latitude": 61.08773,
                                  "longitude": -160.92336
                                },
                                "identifiers": [
                                  {
                                    "type": "AIRPORT_IATA",
                                    "value": "TLT"
                                  }
                                ]
                              },
                              "contacts": []
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "PORT_OF_DISCHARGE",
                              "location": {
                                "name": "Newcastle Airport",
                                "address": {
                                  "addressLines": [
                                    "Newcastle Airport"
                                  ],
                                  "city": "Newcastle",
                                  "country": "AU"
                                },
                                "timeZone": "Australia/Sydney",
                                "geoCoordinates": {
                                  "latitude": -32.795,
                                  "longitude": 151.834
                                },
                                "identifiers": [
                                  {
                                    "type": "AIRPORT_IATA",
                                    "value": "NTL"
                                  },
                                  {
                                    "type": "AIRPORT_ICAO",
                                    "value": "YWLM"
                                  }
                                ]
                              },
                              "contacts": []
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                            }
                          ]
                        },
                        "attributes": [],
                        "shippingDetails": {
                          "air": {
                            "parties": [],
                            "serviceType": "PORT_TO_PORT",
                            "accessorials": []
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 1200
                                },
                                "quantity": 2,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 12,
                                  "width": 44,
                                  "height": 22,
                                  "unit": "FT"
                                },
                                "weight": {
                                  "value": 322,
                                  "unit": "LB"
                                },
                                "items": []
                              }
                            ],
                            "items": [],
                            "identifiers": [
                              {
                                "type": "UNKNOWN",
                                "value": "UNKNOWN"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-11-18",
                        "shipperContactInfo": {
                          "givenName": "Test",
                          "familyName": "User",
                          "email": "test.user@test.com",
                          "phoneNumber": "12233344445",
                          "companyName": "Shipper Co."
                        }
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Tuluksak Airport-Newcastle Airport",
                      "expirationDateTime": "2025-11-07T09:03:37.995000+00:00",
                      "id": "d3bfc028-6bf8-4299-a4f9-0b305a5c1afa",
                      "quotes": [
                        {
                          "id": "25ba37dd-1c89-466d-ac3e-7406c4cd1888",
                          "status": "EXPIRED",
                          "type": "API",
                          "respondByDateTime": "2025-11-07T07:13:38.989361",
                          "expirationDateTime": "2025-11-09T07:03:44.499000",
                          "deliveryDate": "2025-11-20",
                          "pickupDate": "2025-11-18",
                          "totalRate": {
                            "currency": "EUR",
                            "amount": 1250
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "DSVT"
                          },
                          "transportationMode": "AIR",
                          "bookable": true,
                          "createdDateTime": "2025-11-07T07:03:38.464232",
                          "lastModifiedDateTime": "2025-11-07T07:03:45.031319"
                        },
                        {
                          "id": "bfdf0020-1014-49ef-8a71-8582c0663e51",
                          "status": "EXPIRED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-11-07T11:30:00",
                          "expirationDateTime": "2025-11-07T11:30:00",
                          "deliveryDate": "2025-11-21",
                          "pickupDate": "2025-11-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 9898
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "AIR_TEST"
                          },
                          "transportationMode": "AIR",
                          "bookable": true,
                          "createdDateTime": "2025-11-07T07:04:34.662653",
                          "lastModifiedDateTime": "2025-11-07T07:24:11.190943"
                        }
                      ],
                      "marketQuotes": [],
                      "createdDateTime": "2025-11-07T07:03:38.445769",
                      "lastModifiedDateTime": "2025-11-07T07:24:11.190943",
                      "status": "OPEN",
                      "ratingSourceMethod": "API"
                    }
                  },
                  "OCEAN Response": {
                    "summary": "OCEAN Response with quotes",
                    "value": {
                      "identifiers": [],
                      "attributes": [],
                      "rateDetail": {
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PORT_OF_LOADING",
                              "location": {
                                "name": "Shanghai",
                                "address": {
                                  "addressLines": [
                                    "Shengsi County"
                                  ],
                                  "city": "Shanghai",
                                  "country": "CN"
                                },
                                "timeZone": "Asia/Shanghai",
                                "geoCoordinates": {
                                  "latitude": 30.631339230228225,
                                  "longitude": 122.08240185893189
                                },
                                "identifiers": [
                                  {
                                    "type": "PORT_UN_LOCODE",
                                    "value": "CNSHA"
                                  }
                                ]
                              },
                              "contacts": []
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "PORT_OF_DISCHARGE",
                              "location": {
                                "name": "Long Beach",
                                "address": {
                                  "addressLines": [
                                    "1521 Pier J Ave E"
                                  ],
                                  "city": "Long Beach",
                                  "country": "US"
                                },
                                "timeZone": "America/Los_Angeles",
                                "geoCoordinates": {
                                  "latitude": 33.74128740278128,
                                  "longitude": -118.1875674932182
                                },
                                "identifiers": [
                                  {
                                    "type": "PORT_UN_LOCODE",
                                    "value": "USLGB"
                                  }
                                ]
                              },
                              "contacts": []
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "d23b7a9c-415d-4185-a2be-edf74dca79d1",
                              "toStopId": "3c8b706c-2435-49be-9782-0840d342d9be"
                            }
                          ]
                        },
                        "attributes": [],
                        "shippingDetails": {
                          "ocean": {
                            "parties": [
                              {
                                "partyType": "SHIPPER",
                                "contactInfo": {
                                  "companyName": "Shipper Company",
                                  "givenName": "John",
                                  "phoneNumber": "+213424566777",
                                  "email": "jsmith@fmail.com"
                                },
                                "addressInfo": {
                                  "addressLines": [
                                    "222 Merchandise Mart Plz, Suite 1744"
                                  ],
                                  "postalCode": "60654",
                                  "city": "Chicago",
                                  "state": "IL",
                                  "country": "US"
                                }
                              }
                            ],
                            "incoterm": "CPT",
                            "serviceType": "CONTAINER_YARD_TO_CONTAINER_YARD",
                            "bookingType": "FULL_CONTAINER_LOAD",
                            "containerCount": {
                              "dryCargoCount": {
                                "twentyFootContainerCount": 0,
                                "fortyFootContainerCount": 1,
                                "fortyFootHighCubeCount": 0,
                                "fortyfiveFootHighCubeCount": 0
                              }
                            },
                            "accessorials": []
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "freightClass": "50",
                                "monetaryValue": {
                                  "amount": 20000,
                                  "currency": "USD"
                                },
                                "quantity": 12,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 48,
                                  "width": 48,
                                  "height": 48,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "unit": "LB",
                                  "value": 5000
                                },
                                "items": [
                                  {}
                                ]
                              }
                            ],
                            "identifiers": [
                              {
                                "type": "PURCHASE_ORDER",
                                "value": "PO_123"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-05-26",
                        "shipperContactInfo": {
                          "email": "test@shipperco.com",
                          "companyName": "Shipper Co."
                        },
                        "estimatedDeliveryDate": "2025-06-27"
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Shanghai - Long Beach",
                      "expirationDateTime": "2025-05-21T18:11:15.402000+00:00",
                      "id": "92336503-7fe3-4bc3-b3de-9d18728864b2",
                      "quotes": [
                        {
                          "id": "8f3380c3-0051-4a20-b094-253a331402a2",
                          "status": "EXPIRED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "MAEU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:52.058764",
                          "lastModifiedDateTime": "2026-02-10T13:16:52.058764"
                        },
                        {
                          "id": "b8629417-a329-426c-912f-4336f04b3245",
                          "status": "CANCELLED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "EGLV"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:52.058764",
                          "lastModifiedDateTime": "2026-02-10T13:16:58.114585"
                        },
                        {
                          "id": "84585c29-8b2b-466e-99e5-bb37f0a53872",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-04-28",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "MSCU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:51.079582",
                          "lastModifiedDateTime": "2026-02-10T13:16:53.926536"
                        },
                        {
                          "id": "8317acde-0f27-408d-ba53-3769c3234c7e",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-05-12",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "MSCU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.299512",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.299512"
                        },
                        {
                          "id": "ba47465e-3c0a-4961-a581-742ba2136af4",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-04-27",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.090417",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.090417"
                        },
                        {
                          "id": "57b98ccb-49a9-4d85-b763-892b899265d4",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 5235.25
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CMDU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:52.058764",
                          "lastModifiedDateTime": "2026-02-10T13:16:53.231904"
                        },
                        {
                          "id": "76ea37b2-cc41-49b3-88db-95f071d2c32f",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 4950.99
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CMDU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:53.447365",
                          "lastModifiedDateTime": "2026-02-10T13:16:53.447365"
                        },
                        {
                          "id": "b27009ba-9e91-49ac-a71d-a454eee04df9",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 5235.25
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "DSVT"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:52.058764",
                          "lastModifiedDateTime": "2026-02-10T13:16:53.541674"
                        },
                        {
                          "id": "e45b721a-f26f-4894-b623-59a81eda1768",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 4950.99
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "DSVT"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:56.125114",
                          "lastModifiedDateTime": "2026-02-10T13:16:56.125114"
                        },
                        {
                          "id": "4533a357-b498-416b-b1c0-3f2c06ad795d",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-03-27",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:51.630897",
                          "lastModifiedDateTime": "2026-02-10T13:16:53.880223"
                        },
                        {
                          "id": "e4146e24-a052-488a-aab4-f8fff50e3247",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-04-02",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.090417",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.090417"
                        },
                        {
                          "id": "eb9689fc-28af-4965-baa3-3afe4bdf3f3d",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-04-09",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.090417",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.090417"
                        },
                        {
                          "id": "090ebb1a-38fd-4c2a-8f79-95559c69d10d",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-04-16",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.090417",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.090417"
                        },
                        {
                          "id": "e1de2bb3-dc0f-4aa0-915d-97cd5978d14d",
                          "status": "QUOTED",
                          "type": "CONTRACT",
                          "respondByDateTime": "2026-02-10T15:16:50.402000",
                          "deliveryDate": "2026-05-05",
                          "pickupDate": "2026-02-11",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 1
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "YMLU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:54.090417",
                          "lastModifiedDateTime": "2026-02-10T13:16:54.090417"
                        },
                        {
                          "id": "92c8db2f-ce9e-451a-a93e-8cc1b3f788db",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 5235.25
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "HLCU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:52.058764",
                          "lastModifiedDateTime": "2026-02-10T13:16:56.187037"
                        },
                        {
                          "id": "0f128ac1-f810-4335-b1c0-ab0c3ad782ec",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2026-02-10T13:26:51.936968",
                          "expirationDateTime": "2026-03-14T00:00:00",
                          "deliveryDate": "2026-02-18",
                          "totalRate": {
                            "currency": "USD",
                            "amount": 4950.99
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "HLCU"
                          },
                          "transportationMode": "OCEAN",
                          "bookable": true,
                          "createdDateTime": "2026-02-10T13:16:56.388601",
                          "lastModifiedDateTime": "2026-02-10T13:16:56.388601"
                        }
                      ],
                      "marketQuotes": [],
                      "createdDateTime": "2026-02-10T13:16:51.066979",
                      "lastModifiedDateTime": "2026-02-10T13:17:29.560443",
                      "status": "QUOTES_RECEIVED",
                      "ratingSourceMethod": "API"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/rating/v1/rate-requests/{id}": {
      "get": {
        "tags": [
          "Multi-Modal: Rating"
        ],
        "summary": "Get Rate Request",
        "operationId": "get_rate_request_rate_requests__id__get",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "name": "id",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateRequest"
                },
                "examples": {
                  "OTR Response": {
                    "summary": "OTR Response with FTL and LTL quotes",
                    "value": {
                      "rateDetail": {
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PICKUP",
                              "location": {
                                "name": "Rockford Warehouse - Waldom Electronics",
                                "address": {
                                  "addressLines": [
                                    "1804 Morgan St"
                                  ],
                                  "postalCode": "61102",
                                  "city": "Rockford",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "timeZone": "America/Chicago",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Erik Nystrom",
                                  "email": "erik@waldom.com",
                                  "phoneNumber": "+1 815-564-4555",
                                  "companyName": "Waldom Electronics"
                                }
                              ]
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "DELIVERY",
                              "location": {
                                "name": "Online Components",
                                "address": {
                                  "addressLines": [
                                    "2425 S 21st St"
                                  ],
                                  "postalCode": "85034",
                                  "city": "Phoenix",
                                  "state": "AZ",
                                  "country": "US"
                                },
                                "timeZone": "America/Phoenix",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Norma Pomering",
                                  "email": "norma@onlinecomponents.com",
                                  "phoneNumber": "+1 546-645-4354",
                                  "companyName": "Online Components"
                                }
                              ]
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                            }
                          ]
                        },
                        "shippingDetails": {
                          "truck": {
                            "loadPreference": "FULL",
                            "trailerType": "DRY_VAN",
                            "trailerLength": {
                              "value": 53,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 0,
                              "unit": "CUBIC_FT"
                            }
                          },
                          "ltl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            }
                          },
                          "volumeLtl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            },
                            "totalLinearFeet": 24
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "freightClass": "50",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 20000
                                },
                                "quantity": 12,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 48,
                                  "width": 48,
                                  "height": 48,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 5000,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "identifiers": []
                                  }
                                ]
                              }
                            ],
                            "items": [],
                            "identifiers": [
                              {
                                "type": "UNKNOWN",
                                "value": "UNKNOWN"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-05-26",
                        "shipperContactInfo": {
                          "givenName": "John",
                          "familyName": "Smith",
                          "email": "john.smith@shipper.com",
                          "phoneNumber": "+12233344445",
                          "mobilePhoneNumber": "+12233344445",
                          "companyName": "Shipper Co."
                        }
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Rockford - Phoenix",
                      "expirationDateTime": "2025-05-21T18:11:15.585000+00:00",
                      "id": "df60c107-b6d8-46a4-9bb0-7441a59a6f5e",
                      "quotes": [
                        {
                          "id": "5252d6e7-2f55-4998-89db-daf10fd21101",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 3550.79,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "GTJN"
                          },
                          "capacityProviderName": "Go2 Logistics",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        },
                        {
                          "id": "25062bd0-b7fc-41f6-9aab-8f327af65851",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3160.18,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P449"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "4ed16919-08c5-4ce3-8d81-cea6b2bd91c4",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3122,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P446"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "9c08e849-ee91-421f-9f5d-c255e82c58b0",
                          "status": "CANCELLED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "FZMK"
                          },
                          "capacityProviderName": "Fitzmark LLC",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "fb9654f7-7764-486d-ad38-b90f855a5a0d",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 6505.39,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "RLCA"
                          },
                          "capacityProviderName": "R & L CARRIERS",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "ee0402f1-fbe2-4fa6-9ff1-217220dba6ae",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 3219.08,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "RDTF"
                          },
                          "capacityProviderName": "ROADTEX TRANSPORTATION CORP",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "cb150ffb-7664-4b85-9f22-1722a20d36c0",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "totalRate": {
                            "amount": 1031.45,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "CTII"
                          },
                          "capacityProviderName": "CENTRAL TRANSPORT LLC",
                          "transportationMode": "LTL",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        }
                      ],
                      "marketQuotes": [
                        {
                          "id": "4cd6c22c-6c37-4872-a5c0-e4a02e22683f",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 2874,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "SONAR"
                          },
                          "capacityProviderName": "SONAR",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        }
                      ],
                      "createdDateTime": "2025-05-22T10:12:42.500050",
                      "lastModifiedDateTime": "2025-05-22T10:12:42.921013",
                      "status": "QUOTES_REQUESTED",
                      "ratingSourceMethod": "API"
                    }
                  },
                  "FTL Response": {
                    "summary": "FTL Response with quotes",
                    "value": {
                      "rateDetail": {
                        "routeInfo": {
                          "stops": [
                            {
                              "id": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "type": "PICKUP",
                              "location": {
                                "name": "Rockford Warehouse - Waldom Electronics",
                                "address": {
                                  "addressLines": [
                                    "1804 Morgan St"
                                  ],
                                  "postalCode": "61102",
                                  "city": "Rockford",
                                  "state": "IL",
                                  "country": "US"
                                },
                                "timeZone": "America/Chicago",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Erik Nystrom",
                                  "email": "erik@waldom.com",
                                  "phoneNumber": "+1 815-564-4555",
                                  "companyName": "Waldom Electronics"
                                }
                              ]
                            },
                            {
                              "id": "72a2a470-9307-416a-8617-69fb23eea86d",
                              "type": "DELIVERY",
                              "location": {
                                "name": "Online Components",
                                "address": {
                                  "addressLines": [
                                    "2425 S 21st St"
                                  ],
                                  "postalCode": "85034",
                                  "city": "Phoenix",
                                  "state": "AZ",
                                  "country": "US"
                                },
                                "timeZone": "America/Phoenix",
                                "identifiers": []
                              },
                              "contacts": [
                                {
                                  "givenName": "Norma Pomering",
                                  "email": "norma@onlinecomponents.com",
                                  "phoneNumber": "+1 546-645-4354",
                                  "companyName": "Online Components"
                                }
                              ]
                            }
                          ],
                          "routeSegments": [
                            {
                              "fromStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                              "toStopId": "72a2a470-9307-416a-8617-69fb23eea86d"
                            }
                          ]
                        },
                        "shippingDetails": {
                          "truck": {
                            "loadPreference": "FULL",
                            "trailerType": "DRY_VAN",
                            "trailerLength": {
                              "value": 53,
                              "unit": "FT"
                            },
                            "trailerVolume": {
                              "value": 0,
                              "unit": "CUBIC_FT"
                            }
                          },
                          "ltl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            }
                          },
                          "volumeLtl": {
                            "capacityProviderAccountGroup": {
                              "code": "Default",
                              "accounts": []
                            },
                            "totalLinearFeet": 24
                          }
                        },
                        "shipmentDetails": [
                          {
                            "pickupStopId": "fe55f18f-b0d5-484a-8af7-0fd1723a6a24",
                            "deliveryStopId": "72a2a470-9307-416a-8617-69fb23eea86d",
                            "handlingUnits": [
                              {
                                "description": "Electronics",
                                "freightClass": "50",
                                "monetaryValue": {
                                  "currency": "USD",
                                  "amount": 20000
                                },
                                "quantity": 12,
                                "handlingUnitType": "PALLET",
                                "stackable": false,
                                "dimensions": {
                                  "length": 48,
                                  "width": 48,
                                  "height": 48,
                                  "unit": "IN"
                                },
                                "weight": {
                                  "value": 5000,
                                  "unit": "LB"
                                },
                                "items": [
                                  {
                                    "identifiers": []
                                  }
                                ]
                              }
                            ],
                            "items": [],
                            "identifiers": [
                              {
                                "type": "UNKNOWN",
                                "value": "UNKNOWN"
                              }
                            ],
                            "accessorials": []
                          }
                        ],
                        "pickupDate": "2025-05-26",
                        "shipperContactInfo": {
                          "givenName": "John",
                          "familyName": "Smith",
                          "email": "john.smith@shipper.com",
                          "phoneNumber": "+12233344445",
                          "mobilePhoneNumber": "+12233344445",
                          "companyName": "Shipper Co."
                        }
                      },
                      "capacityProviderIdentifiers": [],
                      "name": "Rockford - Phoenix",
                      "expirationDateTime": "2025-05-21T18:11:15.585000+00:00",
                      "id": "df60c107-b6d8-46a4-9bb0-7441a59a6f5e",
                      "marketQuotes": [
                        {
                          "id": "4cd6c22c-6c37-4872-a5c0-e4a02e22683f",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 2874,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "SONAR"
                          },
                          "capacityProviderName": "SONAR",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        }
                      ],
                      "createdDateTime": "2025-05-22T10:12:42.500050",
                      "lastModifiedDateTime": "2025-05-22T10:12:42.921013",
                      "status": "QUOTES_REQUESTED",
                      "ratingSourceMethod": "API",
                      "quotes": [
                        {
                          "id": "5252d6e7-2f55-4998-89db-daf10fd21101",
                          "status": "QUOTED",
                          "type": "API",
                          "respondByDateTime": "2025-05-23T10:22:42.656943",
                          "totalRate": {
                            "amount": 3550.79,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "GTJN"
                          },
                          "capacityProviderName": "Go2 Logistics",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.772977",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.772977"
                        },
                        {
                          "id": "25062bd0-b7fc-41f6-9aab-8f327af65851",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3160.18,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P449"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "4ed16919-08c5-4ce3-8d81-cea6b2bd91c4",
                          "status": "QUOTED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-21T18:11:15.585000",
                          "totalRate": {
                            "amount": 3122,
                            "currency": "USD"
                          },
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "P446"
                          },
                          "capacityProviderName": "receiver_company",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        },
                        {
                          "id": "9c08e849-ee91-421f-9f5d-c255e82c58b0",
                          "status": "CANCELLED",
                          "type": "MANUAL",
                          "respondByDateTime": "2025-05-23T18:11:15.585000",
                          "capacityProviderIdentifier": {
                            "type": "CARRIER_SCAC",
                            "value": "FZMK"
                          },
                          "capacityProviderName": "Fitzmark LLC",
                          "transportationMode": "TRUCKLOAD",
                          "createdDateTime": "2025-05-22T10:12:42.921013",
                          "lastModifiedDateTime": "2025-05-22T10:12:42.921013"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/tracking/v4/events-positions": {
      "post": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Append events and positions to a shipment based on identifiers.",
        "description": "Append events and positions to an existing shipment. The existing shipment is determined by the provided top-level identifiers.",
        "operationId": "carrierPushShipmentAppendMatchIdentifiers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierEventsAndPositions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "06e2e296-ca73-4a64-8b9a-ec17d0bdab3d"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/tracking/v4/route-segments": {
      "put": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Send complete list of route segments for the logistics identifiers indicated in the request body.",
        "description": "Send full route segments snapshot for an existing shipment. The existing shipment is determined by the provided top-level identifiers.",
        "operationId": "carrierPushRouteSegmentsMatchIdentifiers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierRouteDiscovery"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "726bfee1-cf14-4353-aa56-39c4961bf97c"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/tracking/v4/shipments/{shipmentId}/events-positions": {
      "post": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Append events and positions to a shipment based on shipmentId.",
        "description": "Append events and positions to an existing shipment based on shipmentId.",
        "operationId": "carrierPushShipmentAppend",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierEventsAndPositions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "1af82975-75cd-4140-af18-c46ff501529c"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/tracking/v4/shipments/{shipmentId}/route-segments": {
      "put": {
        "tags": [
          "Shipment: Tracking"
        ],
        "summary": "Send complete list of route segments for the shipment.",
        "description": "Send full route segments snapshot for an existing shipment based on the shipmentId.",
        "operationId": "carrierPushRouteSegments",
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CarrierRouteDiscovery"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "37a30045-df44-4805-a198-4e51f34e1d93"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/unified-integrations/v1/connections/{connectionId}/ingestions": {
      "post": {
        "description": "Ingest custom formatted data in the request body. This can be any kind of formatted payload (JSON, XML, etc) or binary data. A connection needs to be first created by p44 internally in the P44 Connection Manager UI for each data provider and data format before ingesting data. Reach out to P44 Support team to receive the connectionId for your integration.",
        "operationId": "createConnectionsIngestion",
        "parameters": [
          {
            "in": "path",
            "name": "connectionId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "string"
              }
            }
          },
          "description": "Custom content of the data provider. Can be any format supported by the connection, e.g. JSON, XML, binary data, ...",
          "required": true
        },
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "message": "A description of the error that occurred.",
                      "severity": "ERROR"
                    }
                  ],
                  "httpMessage": "Bad Request",
                  "httpStatusCode": 400,
                  "supportReferenceId": "097db21a-012b-41ae-a2ab-13b4b0583709"
                },
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Missing or invalid user context headers."
          },
          "403": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "message": "A description of the error that occurred.",
                      "severity": "ERROR"
                    }
                  ],
                  "httpMessage": "Forbidden",
                  "httpStatusCode": 403,
                  "supportReferenceId": "e70da264-bbe0-4a10-9a53-aae17675f1da"
                },
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Connection does not correspond to data provider"
          },
          "404": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "message": "A description of the error that occurred.",
                      "severity": "ERROR"
                    }
                  ],
                  "httpMessage": "Not Found",
                  "httpStatusCode": 404,
                  "supportReferenceId": "0e3757a3-0fba-4e87-af7d-0973f2aa8080"
                },
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Connection does not exist"
          },
          "413": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "message": "A description of the error that occurred.",
                      "severity": "ERROR"
                    }
                  ],
                  "httpMessage": "Payload Too Large",
                  "httpStatusCode": 413,
                  "supportReferenceId": "6c5fe311-3abd-46ce-bb73-b40276b91926"
                },
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Request Payload is too large, should be maximum 1 MB"
          }
        },
        "summary": "Ingest data for a specific connection.",
        "tags": [
          "Push Updates"
        ],
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/unified-search/v1/shipments/count": {
      "post": {
        "tags": [
          "Shipment Search"
        ],
        "summary": "Count shipments which match a set of criteria",
        "description": "A combination of criteria is expected (but not required) in the request body.\n\nThe count is implicitly limited to shipments visible to the tenant performing the call.\n\nIf no criteria is present in the request body, then the response will contain a count of shipments visible to the tenant making the request.",
        "operationId": "count",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentSearchCriteria"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentCount"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "9b91efbd-7b3d-4796-adf5-c1b16582950c"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/unified-search/v1/shipments/search": {
      "post": {
        "tags": [
          "Shipment Search"
        ],
        "summary": "Search for shipments which match a set of criteria",
        "description": "A combination of criteria is expected (but not required) in the request body. \n\nThe search is implicitly limited to shipments visible to the tenant performing the call.\n\nIf no criteria is present in the request body, then the response will contain a page of shipments visible to the tenant making the request.\n\nThis endpoint cannot return pages larger than 1,000 items, and it cannot page deeper than 10,000 results.",
        "operationId": "search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentSearchRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentSummaryPage"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "c4c87aba-5956-452d-8f3b-367ba6ccae60"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/services/unified-search/v1/suggestions": {
      "post": {
        "tags": [
          "Filter Suggestions"
        ],
        "summary": "Retrieve a list of suggested values which can be used as search criteria in other endpoints",
        "description": "A suggestion is defined as a value which has existed at some point in time for the given field type in any shipment visible to the tenant performing the call.\n\nSuggestions are sorted such that the most relevant results will be at the top, and any equally relevant results are sorted alphabetically.",
        "operationId": "getFilterSuggestions",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FilterSuggestionRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FilterSuggestionResponse"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid user context headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                },
                "example": {
                  "httpStatusCode": 400,
                  "httpMessage": "Bad Request",
                  "errors": [
                    {
                      "severity": "ERROR",
                      "message": "A description of the error that occurred."
                    }
                  ],
                  "supportReferenceId": "9796c99d-61f5-4dde-afe8-b44afc814ebc"
                }
              }
            }
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ]
      }
    },
    "/webhook-schema": {
      "post": {
        "description": "Example of how the webhook payload looks like.",
        "tags": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UnifiedWebhookMessage"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "summary": "-",
        "security": [
          {
            "oAuth2": []
          }
        ],
        "operationId": "post_webhookschema"
      }
    },
    "/api/v4/rail/shipments": {
      "post": {
        "description": "If the shipment is initialized by using geoCoordinates instead of an address, it may be possible that a street address will not be returned in the response.  \n\n<br/><h4><b>Required Fields</h4></b>\n<ul><li><b>  shipmentIdentifiers: </b> (if no trackingStartDateTime provided) </li><ul><li> type </li><li> value </li></ul><li><b>  equipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li> trackingStartDateTime (if no shipmentIdentifiers provided) </li></ul>",
        "operationId": "createRailShipment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RailShipment"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/RailShipment"
              }
            }
          },
          "description": "shipment",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentConfirmation"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/RailShipmentConfirmation"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "Invalid or missing credentials"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            },
            "description": "User not authorized to perform this operation"
          }
        },
        "security": [
          {
            "oAuth2": []
          }
        ],
        "summary": "Initialize a shipment for tracking.",
        "tags": [
          "Rail: Tracking"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AccessGroup": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the access group",
            "format": "uuid",
            "xml": {
              "wrapped": true
            }
          }
        },
        "description": "A group within the tenant used to group together users that should be entitled the same subset of data."
      },
      "Accessorial": {
        "type": "object",
        "properties": {
          "appointmentDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AppointmentDetails"
              }
            ],
            "description": "Optional attribute to indicate the pickup and delivery appointment details type when accessorial code APTP or APTD is present in the accessorial codes list."
          },
          "codes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccessorialCode"
            },
            "description": "An array to hold the list of services requested for the shipment."
          },
          "cod": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Cod"
              }
            ],
            "description": "Required when accessorial code COD is present in the accessorial codes list."
          },
          "fullValueCoverageDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FullValueCoverageDetails"
              }
            ],
            "description": "Required when accessorial code FVC is present in the accessorial codes list."
          },
          "hazardousDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HazardousDetailsContact"
              }
            ],
            "description": "Required if accessorial codes list contains HAZ and/or if any commodity line item's hazardous flag is set to true."
          },
          "limitedAccessType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LimitedAccessType"
              }
            ],
            "description": "Optional attribute to indicate the limited access type when accessorial code LTDAP or LTDAD is present in the accessorial codes list."
          },
          "markDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MarkDetails"
              }
            ],
            "description": "Required when accessorial code MARK is present in the accessorial codes list."
          },
          "sortAndSegregateDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SortAndSegregateDetails"
              }
            ],
            "description": "Required when accessorial code SRT is present in the accessorial codes list."
          },
          "timeCriticalDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeCriticalDetails"
              }
            ],
            "description": "Optional attribute to indicate the time critical details when accessorial code TCS is present in the accessorial codes list."
          }
        }
      },
      "AccessorialCode": {
        "enum": [
          "APTD",
          "APTP",
          "COD",
          "EXPD",
          "FVC",
          "GTD_AM",
          "GTD_NOON",
          "GTD_PM",
          "HAZ",
          "IDL",
          "INBD",
          "IPU",
          "LFTD",
          "LFTP",
          "LTDAD",
          "LTDAP",
          "MARK",
          "MNC",
          "OVR",
          "PPD",
          "PSC",
          "PSH",
          "PSN",
          "REP",
          "RES",
          "SRT",
          "SS",
          "TCS"
        ],
        "type": "string",
        "description": "Accessorial codes"
      },
      "AccessorialService": {
        "description": "An accessorial service requested of a carrier tendering a shipment.",
        "properties": {
          "code": {
            "description": "The code for the requested accessorial service. A list of accessorial service codes supported by project44 is provided in the API reference data section.",
            "type": "string"
          }
        },
        "title": "AccessorialService",
        "type": "object"
      },
      "AccessorialServiceConfiguration": {
        "description": "Contains fields used to configure the rate quote accessorial services.",
        "properties": {
          "allowUnacceptedAccessorials": {
            "description": "If set to 'true', rate quotes will be allowed from capacity providers that do not accept one or more requested accessorial services. The default behavior is to reject a rate quote with an error from any capacity provider that does not accept every requested accessorial service in the query. (default: 'false')",
            "type": "boolean"
          },
          "fetchAllGuaranteed": {
            "description": "If set to 'true', rate quotes for all possible guaranteed service levels (e.g., guaranteed by noon or guaranteed by 3pm) will be retrieved from each capacity provider, based on what each provider offers. (default: 'false')",
            "type": "boolean"
          },
          "fetchAllInsideDelivery": {
            "description": "If set to 'true', rate quotes for all possible inside delivery accessorial services will be retrieved from each capacity provider, based on what each provider offers. (default: 'false')",
            "type": "boolean"
          },
          "fetchAllServiceLevels": {
            "description": "If set to 'true', rate quotes for all possible service levels (e.g., guaranteed or expedited) will be retrieved from each capacity provider, based on what each provider offers. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "AccessorialServiceConfiguration",
        "type": "object"
      },
      "AdditionalAppointmentWindowIdentifier": {
        "description": "A user defined additional appointment window identifier to be used in lists.",
        "properties": {
          "type": {
            "description": "The type of additional appointment window identifier.",
            "enum": [
              "DOCK",
              "BOOKING_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of additional appointment window identifier.",
            "type": "string"
          }
        },
        "title": "AdditionalAppointmentWindowIdentifier",
        "type": "object"
      },
      "AdditionalOrderIdentifier": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "CONTRACT",
              "LOAD",
              "MANUFACTURER",
              "PROMOTION",
              "SEASON",
              "VENDOR",
              "LAUNCH_CODE",
              "CUSTOMER_ORDER"
            ]
          },
          "value": {
            "type": "string"
          }
        },
        "description": "Additional terms to describe the order."
      },
      "AdditionalReference": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Indicates the name of the reference number being provided."
          },
          "value": {
            "type": "string",
            "description": "Additional reference number that correlates to the additional reference name."
          }
        }
      },
      "Address": {
        "type": "object",
        "properties": {
          "addressLines": {
            "type": "array",
            "description": "Street name, number, direction, PO box, etc. Only three address lines are currently permitted.",
            "items": {
              "type": "string",
              "description": "Street name, number, direction, PO box, etc. Only three address lines are currently permitted."
            }
          },
          "city": {
            "type": "string",
            "description": "Name of city, town, etc."
          },
          "country": {
            "$ref": "#/components/schemas/CountryCode"
          },
          "postalCode": {
            "type": "string",
            "description": "The ZIP or postal code."
          },
          "state": {
            "type": "string",
            "description": "Abbreviation of state, province, district, etc."
          }
        },
        "description": "A postal address."
      },
      "AirCargoMeasurements": {
        "properties": {
          "dimensions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Dimensions"
              }
            ],
            "description": "The height, length, width dimensions of the cargo"
          },
          "volume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "The volume of the cargo"
          },
          "weight": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingWeight"
              }
            ],
            "description": "The weight of the cargo"
          }
        },
        "type": "object"
      },
      "AirDetails": {
        "properties": {
          "accessorials": {
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "type": "array",
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirCargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo. \n"
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirIncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array",
            "description": "Individual shipper-represented groups which are involved with the shipment."
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or inland locations."
          }
        },
        "required": [],
        "type": "object"
      },
      "AirFlightDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "flightDetails": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FlightInformation"
            }
          }
        }
      },
      "AirIncotermType": {
        "type": "string",
        "enum": [
          "EXW",
          "FCA",
          "FAS",
          "FOB",
          "CFR",
          "CIF",
          "CPT",
          "CIP",
          "DPU",
          "DAP",
          "DDP"
        ],
        "description": "International commercial terms according to the [ICC](https://iccwbo.org/).\n\nEXW: EX WORKS, FCA: FREE CARRIER, FAS: FREE ALONGSIDE SHIP,\nFOB: FREE ON BOARD, CFR: COST & FREIGHT, CIF: COST, INSURANCE & FREIGHT\nCPT: COST PAID TO, CIP: CARRIER & INSURANCE PAID TO, DPU: DELIVERED AT PLACE UNLOADED\nDAP: DELIVERED AT PLACE, DDP: DELIVERED DUTY PAID"
      },
      "AirportDetails": {
        "properties": {
          "estimatedArrivalDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Optional date and time at the port. Required when port type is 'PORT_OF_DISCHARGE'."
          },
          "estimatedDepartureDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Optional date and time at the port. Required when port type is 'PORT_OF_LOADING'."
          },
          "location": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingLocation"
              }
            ],
            "description": "The location of the port."
          },
          "portType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirPortType"
              }
            ],
            "description": "Port type"
          }
        },
        "type": "object",
        "required": []
      },
      "AirPortType": {
        "type": "string",
        "enum": [
          "PORT_OF_LOADING",
          "PORT_OF_DISCHARGE",
          "TRANSSHIPMENT_PORT"
        ],
        "description": "An enumeration."
      },
      "AirServiceType": {
        "type": "string",
        "enum": [
          "PORT_TO_PORT",
          "PORT_TO_DOOR",
          "DOOR_TO_PORT",
          "DOOR_TO_DOOR"
        ],
        "description": "An enumeration."
      },
      "AirShippingDetails": {
        "properties": {
          "accessorials": {
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "type": "array",
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "airportDetails": {
            "items": {
              "$ref": "#/components/schemas/AirportDetails"
            },
            "type": "array",
            "description": "List of ports and arrival dates"
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirCargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo."
          },
          "estimatedFinalDestinationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Estimated time for goods to arrive to destination"
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirIncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "items": {
              "$ref": "#/components/schemas/BookingParty"
            },
            "type": "array",
            "minItems": 1,
            "description": "Individual shipper-represented groups which are involved with the shipment on this"
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or inland locations."
          }
        },
        "type": "object",
        "required": []
      },
      "AlternateRateQuote": {
        "description": "An alternate rate quote provided along with the primary rate quote from a single carrier.",
        "properties": {
          "capacityProviderQuoteNumber": {
            "description": "The capacity provider's identifier for this alternate rate quote, if provided.",
            "type": "string"
          },
          "deliveryDateTime": {
            "description": "The delivery date and time for this alternate rate quote in the timezone of the destination location, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "rateQuoteDetail": {
            "$ref": "#/components/schemas/RateQuoteDetail"
          },
          "serviceLevel": {
            "$ref": "#/components/schemas/ServiceLevel"
          },
          "transitDays": {
            "description": "The number of service days to deliver the shipment being quoted after it is picked up, if provided.",
            "format": "int32",
            "type": "integer"
          },
          "transitDaysRange": {
            "$ref": "#/components/schemas/IntegerRange"
          }
        },
        "title": "AlternateRateQuote",
        "type": "object"
      },
      "ApiConfiguration": {
        "type": "object",
        "properties": {
          "bookingWebhookName": {
            "type": "string",
            "description": "An optional name of the webhook that will receive updates for this booking."
          }
        }
      },
      "ApiError": {
        "description": "Representation of an error that occurs during API execution and results in a 4xx or 5xx HTTP status code.",
        "properties": {
          "errorMessage": {
            "description": "Description of the error.",
            "type": "string"
          },
          "errors": {
            "description": "(Optional) Collection of Message objects which provide further information as to the cause of this error.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "httpMessage": {
            "description": "Description of the HTTP status code.",
            "type": "string"
          },
          "httpStatusCode": {
            "description": "The value of the HTTP status code.",
            "format": "int32",
            "type": "integer"
          },
          "supportReferenceId": {
            "description": "A reference identifier used by project44 support to assist with certain error messages.",
            "type": "string"
          }
        },
        "title": "ApiError",
        "type": "object"
      },
      "Appointment": {
        "type": "object",
        "properties": {
          "appointmentId": {
            "type": "integer",
            "description": "Unique identifier for the appointment",
            "example": 12345
          },
          "scheduleStartDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Scheduled start date and time for the appointment",
            "example": "2024-01-15T10:00:00Z"
          },
          "scheduleEndDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Scheduled end date and time for the appointment",
            "example": "2024-01-15T12:00:00Z"
          },
          "slotDurationInMinutes": {
            "type": "integer",
            "description": "Duration of the appointment slot in minutes",
            "example": 120
          }
        }
      },
      "AppointmentDetails": {
        "type": "object",
        "properties": {
          "delivery": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeliveryAppointmentDetails"
              }
            ],
            "description": "Delivery appointment details."
          },
          "pickup": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PickupAppointmentDetails"
              }
            ],
            "description": "Pickup appointment details."
          }
        }
      },
      "AppointmentRequiredAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "APPOINTMENT_REQUIRED"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for appointment service."
      },
      "AppointmentsFieldsSchema": {
        "type": "object",
        "required": [],
        "properties": {
          "identifiers": {
            "$ref": "#/components/schemas/Identifiers",
            "description": "Object containing shipment and site identification details. See the Identifiers schema for details."
          },
          "slotStartDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The start date and time (in ISO 8601 format) for the requested appointment slot. Must be before slotEndDateTime. Example: '2024-01-15T10:00:00Z'.",
            "example": "2024-01-15T10:00:00Z"
          },
          "slotEndDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The end date and time (in ISO 8601 format) for the requested appointment slot. Must be after slotStartDateTime. Example: '2024-01-15T12:00:00Z'.",
            "example": "2024-01-15T12:00:00Z"
          }
        }
      },
      "AppointmentsRescheduleFieldsSchema": {
        "type": "object",
        "properties": {
          "identifiers": {
            "$ref": "#/components/schemas/Identifiers",
            "description": "Object containing shipment and site identification details for the rescheduled appointment. See the Identifiers schema for details."
          },
          "reasonCode": {
            "type": "string",
            "description": "A code indicating the reason for rescheduling the appointment. This helps in tracking and analytics of appointment changes. Example: 'RESCHEDULE'.",
            "example": "RESCHEDULE"
          },
          "slotStartDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The new start date and time (in ISO 8601 format) for the rescheduled appointment slot. Must be before slotEndDateTime. Example: '2024-01-16T14:00:00Z'.",
            "example": "2024-01-16T14:00:00Z"
          },
          "slotEndDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The new end date and time (in ISO 8601 format) for the rescheduled appointment slot. Must be after slotStartDateTime. Example: '2024-01-16T16:00:00Z'.",
            "example": "2024-01-16T16:00:00Z"
          }
        }
      },
      "AppointmentsResponse": {
        "type": "object",
        "properties": {
          "appointment": {
            "$ref": "#/components/schemas/Appointment"
          },
          "location": {
            "$ref": "#/components/schemas/YmsLocation"
          },
          "milestones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Milestones"
            }
          },
          "status": {
            "type": "string",
            "description": "Status of the operation",
            "example": "SUCCESS"
          },
          "yardShipment": {
            "$ref": "#/components/schemas/YardShipment"
          }
        }
      },
      "ArrivalStatus": {
        "description": "arrival status.",
        "properties": {
          "code": {
            "description": "Code of the arrival status (EARLY, LATE, ON_TIME).",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "duration": {
            "$ref": "#/components/schemas/TimeDuration"
          }
        },
        "title": "ArrivalStatus",
        "type": "object"
      },
      "AssetTrackingSubscription": {
        "properties": {
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/EquipmentIdentifier"
          },
          "expirationDateTime": {
            "description": "Optional time to stop tracking as asset. This is a date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2019-12-03T10:15:30+01:00. If not provided, it will be set to six months from the enrollment time.",
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "webhookName": {
            "description": "The name of the previously registered webhook. This indicates where to send the asset tracking information.",
            "type": "string"
          }
        },
        "title": "AssetTrackingSubscription",
        "type": "object"
      },
      "Attribute": {
        "description": "Contains a key and value for custom attributes.",
        "properties": {
          "name": {
            "description": "The name for an attribute. Must be unique.",
            "type": "string"
          },
          "values": {
            "description": "The values for an attribute.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "Attribute",
        "type": "object"
      },
      "AutomatedFailureReason": {
        "enum": [
          "ERROR_CREDENTIALS",
          "NO_RESPONSE_CARRIER",
          "INTERNAL_ERROR_CARRIER",
          "UNKNOWN_ERROR_CARRIER",
          "INTERNAL_ERROR_VCS",
          "UNKNOWN_ERROR_VCS",
          "UNSUPPORTED_EQUIPMENT_TYPE",
          "UNSUPPORTED_MODE",
          "UNSUPPORTED_COUNTRY",
          "UNSUPPORTED_STOP_TYPE",
          "MISSING_DATA",
          "INVALID_DATA"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "AvailableSlot": {
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "End date and time for the available slot (with timezone)",
            "example": "2024-01-15T12:00:00-05:00"
          },
          "section": {
            "type": "string",
            "description": "Section/dock door identifier",
            "example": "DOCK001"
          },
          "startDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Start date and time for the available slot (with timezone)",
            "example": "2024-01-15T10:00:00-05:00"
          }
        }
      },
      "AvailableVehicles": {
        "properties": {
          "terminatingCapacity": {
            "$ref": "#/components/schemas/TerminatingCapacity"
          }
        },
        "title": "AvailableVehicles",
        "type": "object"
      },
      "AvailableVehiclesPage": {
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/AvailableVehicles"
            },
            "type": "array"
          }
        },
        "title": "AvailableVehiclesPage",
        "type": "object"
      },
      "AvailableVehiclesQuery": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "includeMyShipments": {
            "description": "Allows users to exclude shipments belonging to their tenant.",
            "type": "boolean"
          },
          "radius": {
            "description": "Search radius for capacity. Default is 25 miles or 40 km if no value is submitted. Valid values are any integer between 10-50 for miles and 16-80 for km.",
            "format": "int32",
            "type": "integer"
          },
          "radiusUnit": {
            "description": "Unit of the search radius for capacity. Default is miles.",
            "enum": [
              "FT",
              "M",
              "MI",
              "KM"
            ],
            "type": "string"
          },
          "sharingPool": {
            "description": "Optional parameter that will only return results from a specified pool. This will only apply to customers in more than 1 pool.",
            "type": "string"
          },
          "timeRange": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "truckType": {
            "description": "Optional parameter that will return available capacity specific to the type of truck requested.",
            "enum": [
              "AUTO_CARRIER",
              "B_TRAIN",
              "CONESTOGA",
              "CONTAINER",
              "CONTAINER_INSULATED",
              "CONTAINER_REFRIGERATED",
              "CONVEYOR",
              "DOUBLE_DROP",
              "DROP_DECK_LANDOLL",
              "DUMP_TRAILER",
              "FLAT_BED",
              "FLATBED_AIR_RIDE",
              "FLATBED_CONESTOGA",
              "FLATBED_DOUBLE",
              "FLATBED_HAZMAT",
              "FLATBED_HOTSHOT",
              "FLATBED_MAXI",
              "FLATBED_STEP_DECK",
              "FLATBED_OVERDOMENSION",
              "FLATBED_OVERDIMENSION",
              "FLATBED_CHAINS",
              "FLATBED_SIDES",
              "FLATBED_TARPS",
              "FLATBED_TEAM",
              "FLATBED_VAN_REEFER",
              "HOPPER_BOTTOM",
              "INSULATED_VAN_REEFER",
              "LOWBOY",
              "LOWBOY_REM_GOOSENECK",
              "LOWBOY_OVERDIMENSION",
              "MOVING_VAN",
              "PNEUMATIC",
              "POWER_ONLY",
              "REEFER",
              "REEFER_AIR_RIDE",
              "REEFER_DOUBLE",
              "REEFER_HAZMAT",
              "REEFER_INTERMODAL",
              "REEFER_LOGISTICS",
              "REEFER_VENTED_VAN",
              "REEFER_PALLET_EXCHANGE",
              "REEFER_TEAM",
              "REMOVABLE_GOOSENECK",
              "STEP_DECK",
              "STEP_DECK_REM_GOOSENECK",
              "STEP_DECK_CONESTOGA",
              "STRAIGHT_BOX_TRUCK",
              "STRETCH_TRAILER",
              "TANKER_ALUMINUM",
              "TANKER_INTERMODAL",
              "TANKER_STEEL",
              "TRUCK_AND_TRAILER",
              "DRY_VAN",
              "VAN",
              "VAN_AIR_RIDE",
              "VAN_BLANKET_WRAP",
              "VAN_CONESTOGA",
              "VAN_DOUBLE",
              "VAN_HAZMAT",
              "VAN_HOTSHOT",
              "VAN_INSULATED",
              "VAN_INTERMODAL",
              "VAN_LIFT_GATE",
              "VAN_LOGISTICS",
              "VAN_OPEN_TOP",
              "VAN_FLATBED",
              "VAN_FLATBED_TARPS",
              "VAN_FLATBET",
              "VAN_FLATBET_TARPS",
              "VAN_REEFER",
              "VAN_PALLET_EXCHANGE",
              "VAN_ROLLER_BED",
              "VAN_TRIPLE",
              "VAN_VENTED",
              "VAN_CURTAINS",
              "VAN_TEAM"
            ],
            "type": "string"
          }
        },
        "title": "AvailableVehiclesQuery",
        "type": "object"
      },
      "BasicInventoryItemSearchCriteria": {
        "description": "BasicInventoryItemSearchCriteria contains criteria used to search inventory item data.",
        "properties": {
          "consumeByDateTimeRange": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "hazardClasses": {
            "description": "Search for items with hazard classes that match the provided hazard classes.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "ids": {
            "description": "Search for items with ids that match the provided ids.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "inventoryIdentifiers": {
            "description": "Search for items with inventory identifiers that match the provided inventory identifiers (InventoryIdentifier.type, InventoryIdentifier.description, InventoryIdentifier.value).",
            "items": {
              "$ref": "#/components/schemas/InventoryIdentifier"
            },
            "type": "array"
          },
          "manufacturedDateTimeRange": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "orderIds": {
            "description": "Search for items with order ids that match the provided order ids.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "packagedDateTimeRange": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "perUnitCost": {
            "$ref": "#/components/schemas/MonetaryValueRangeFilter"
          },
          "perUnitRetailValue": {
            "$ref": "#/components/schemas/MonetaryValueRangeFilter"
          },
          "perishable": {
            "description": "Search for items which are perishable (true) or non-perishable (false).",
            "type": "boolean"
          },
          "searchText": {
            "description": "Provide a multi field text search across the full inventory item object.",
            "type": "string"
          },
          "sellByDateTimeRange": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "shipmentIds": {
            "description": "Search for items with shipment ids that match the provided shipment ids. These must be project44-generated masterShipmentIds.",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "skus": {
            "description": "Search for items with stock keeping units that match the provided stock keeping units.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "taxable": {
            "description": "Search for items which are taxable (true) or non-taxable (false).",
            "type": "boolean"
          },
          "upcs": {
            "description": "Search for items with universal product codes that match the provided universal product codes.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "BasicInventoryItemSearchCriteria",
        "type": "object"
      },
      "BasicInventoryOrderSearchCriteria": {
        "description": "BasicInventoryOrderSearchCriteria contains criteria used to search inventory order data.",
        "properties": {
          "additionalOrderIdentifierCriteria": {
            "description": "Search for orders with additional identifiers matching the list of identifiers provided. If a combination value/values + type with an operator is provided, it performs a search operation with value matching the criteria for the given type. If just a type or value/values is provided with an operator, the search criteria with type or value matching the criteria.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderIdentifierCriteria"
            },
            "type": "array"
          },
          "billToLocationAddressText": {
            "description": "Search for orders whose bill-to location match the given address fields (i.e. postalCode, addressLines, city, state, country).",
            "type": "string"
          },
          "destinationLocationAddressText": {
            "description": "Search for orders whose destination location match the given address fields. (i.e. postalCode, addressLines, city, state, country).",
            "type": "string"
          },
          "hasShipmentIds": {
            "description": "Search for the existence of shipmentIds on an order.  If value is 'true', it searches for orders that contain shipments.  If the value is 'false', it searches for orders that contain no shipments.  If the value is null, this criterion is excluded.  If this is used in combination with 'shipmentIds' search criteria, it might cause unexpected results.",
            "type": "boolean"
          },
          "ids": {
            "description": "Search for orders with ids that match the provided ids.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "launchDateTime": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "orderAttributes": {
            "description": "Search for orders that contain the provided custom attributes.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderAttributeFilter"
            },
            "type": "array"
          },
          "orderHealthCriteria": {
            "description": "Search for orders based on arrival status, duration range / delta, target date range, or the combination of any.",
            "items": {
              "$ref": "#/components/schemas/OrderHealthCriteria"
            },
            "type": "array"
          },
          "orderIdentifierCriteria": {
            "description": "${InventoryOrderSearchCriteria.apiModel.orderIdentifierCriteria.value}",
            "items": {
              "$ref": "#/components/schemas/OrderIdentifierCriteria"
            },
            "type": "array"
          },
          "orderIdentifiers": {
            "description": "Search for orders with identifiers that match the provided order identifiers.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "orderItemAdditionalIdentifierCriteria": {
            "description": "${InventoryOrderSearchCriteria.apiModel.orderItemInventoryIdentifierCriteria.value}",
            "items": {
              "$ref": "#/components/schemas/OrderItemAdditionalIdentifierCriteria"
            },
            "type": "array"
          },
          "orderItemDescriptionCriteria": {
            "description": "${InventoryOrderSearchCriteria.apiModel.orderItemDescriptionCriteria.value}",
            "items": {
              "$ref": "#/components/schemas/OrderItemDescriptionCriteria"
            },
            "type": "array"
          },
          "orderItemIdentifierCriteria": {
            "description": "${InventoryOrderSearchCriteria.apiModel.orderItemIdentifierCriteria.value}",
            "items": {
              "$ref": "#/components/schemas/OrderItemIdentifierCriteria"
            },
            "type": "array"
          },
          "orderLocationCriteria": {
            "description": "${InventoryOrderSearchCriteria.apiModel.orderLocationCriteria.value}",
            "items": {
              "$ref": "#/components/schemas/OrderLocationCriteria"
            },
            "type": "array"
          },
          "orderSubmissionDateTime": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "orderTagCriteria": {
            "description": "Search for items with order tags based matching the list of tags provided.If a combination value/values + type with an operator is provided, it performs a search operation with value matching the criteria for the given type. If just a type or value/values is provided with an operator, the search criteria with type or value matching the criteria.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderTagCriteria"
            },
            "type": "array"
          },
          "orderTypes": {
            "description": "Search for orders with types that match the provided types.",
            "items": {
              "enum": [
                "PURCHASE_ORDER",
                "SALES_ORDER",
                "WAREHOUSE_MOVEMENT_ORDER",
                "ADVANCED_SHIPMENT_NOTICE",
                "INVOICE",
                "DELIVERY",
                "STOCK_TRANSFER_ORDER"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "originLocationAddressText": {
            "description": "Search for orders whose origin location match the given address fields. (i.e. postalCode, addressLines, city, state, country).",
            "type": "string"
          },
          "originalDeliveryDateTimeWindowEnd": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "originalDeliveryDateTimeWindowStart": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "pagination": {
            "$ref": "#/components/schemas/PaginationParameters"
          },
          "relatedOrderIds": {
            "description": "Search for orders that contain related orders matching the provided ids.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "searchText": {
            "description": "Provide a multi field text search across the full inventory order object.",
            "type": "string"
          },
          "shipmentIds": {
            "description": "Search for orders with shipment ids that match the provided shipment ids. These must be project44-generated masterShipmentIds.",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "sort": {
            "description": "A collection of fields on which to sort the search results, and the direction of the sort for each field.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderSortField"
            },
            "type": "array"
          },
          "statusCodes": {
            "description": "Search for orders containing any of the provided status codes.",
            "items": {
              "enum": [
                "SUBMITTED",
                "RECEIVED",
                "PROCESSING",
                "ACCEPTED",
                "FULFILLED",
                "REJECTED",
                "CANCELED"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "supplierReadyDateTimeWindowEnd": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "supplierReadyDateTimeWindowStart": {
            "$ref": "#/components/schemas/OffsetDateTimeRangeFilter"
          },
          "vendorLocationAddressText": {
            "description": "Search for orders whose vendor location match the given address fields (i.e. postalCode, addressLines, city, state, country).",
            "type": "string"
          }
        },
        "title": "BasicInventoryOrderSearchCriteria",
        "type": "object"
      },
      "Body_create_document_documents_post": {
        "required": [],
        "type": "object",
        "properties": {
          "document": {
            "type": "string"
          },
          "upload_file": {
            "type": "string",
            "format": "binary"
          }
        }
      },
      "Body_search_documents_documents_search_post": {
        "type": "object",
        "properties": {
          "identifiers": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IdentifierWrapper"
              }
            ],
            "description": "List of logistics identifiers. Only equal operator is supported."
          },
          "name": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameWrapper"
              }
            ],
            "description": "The name of the document to search for"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TypeWrapper"
              }
            ],
            "description": "List of document types to filter. Only equal operator is supported."
          }
        }
      },
      "Bol": {
        "required": [],
        "type": "object",
        "properties": {
          "function": {
            "type": "string",
            "description": "The intent for the submitted request.",
            "default": "Create"
          },
          "isTest": {
            "type": "boolean",
            "description": "Indicates whether or not the submitted request is intended to be a test or not.",
            "default": false
          },
          "requestedPickupDate": {
            "type": "string",
            "description": "The intended Ship Date.",
            "format": "date-time"
          },
          "requestorRole": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RequestorRoleCode"
              }
            ],
            "description": "Identifies the party making the request."
          },
          "specialInstructions": {
            "type": "string",
            "description": "Special delivery instructions that need to be followed for the shipment's delivery."
          }
        }
      },
      "BookedShipment": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 5,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers."
          },
          "bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Booking"
            },
            "description": "A list of all bookings related to the shipment."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The datetime when the shipment was created.",
            "format": "date-time"
          },
          "identifiers": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "id": {
            "type": "string",
            "description": "The project44-generated shipment identifier",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The datetime when the shipment was last updated.",
            "format": "date-time"
          },
          "name": {
            "type": "string",
            "description": "The descriptive name or otherwise human-readable description of the shipment created; this is not visible to the carrier."
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "routeInfo": {
            "$ref": "#/components/schemas/RouteInfo"
          }
        },
        "description": "The overall shipper's construct of the material good(s) to be transported by the carrier."
      },
      "BookedShipmentPage": {
        "required": [],
        "type": "object",
        "properties": {
          "paginationInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaginationInfo"
              }
            ],
            "description": "Pagination information about a collection of resources."
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookedShipment"
            },
            "description": "List of resources contained on this page."
          }
        },
        "description": "A paginated response containing results and information about the current page."
      },
      "BookedSlot": {
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "End date and time for the booked slot (with timezone)",
            "example": "2024-01-15T11:00:00-05:00"
          },
          "shipmentNumber": {
            "type": "string",
            "description": "Shipment number that has booked this slot",
            "example": "SHIP123456"
          },
          "startDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Start date and time for the booked slot (with timezone)",
            "example": "2024-01-15T09:00:00-05:00"
          }
        }
      },
      "Booking": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "A shipper-provided list of custom key-value list pairs relevant to the booking which are shared with the carrier."
          },
          "apiConfiguration": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ApiConfiguration"
              }
            ],
            "description": "Field for configuring the behavior of this API."
          },
          "automatedFailureReason": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AutomatedFailureReason"
              }
            ],
            "description": "The reason a booking may not have been properly requested, or its response from the carrier may not have been retrieved for bookings which are relayed to the carrier through an automated means (EDI, API)."
          },
          "bookingSourceMethod": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingSourceMethod"
              }
            ],
            "description": "Shipper made booking request by WebGUI or API",
            "default": "API"
          },
          "capacityProviderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
              }
            ],
            "description": "Reference to the desired carrier to transport the shipment across the booking's specified route segments."
          },
          "carrierContacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingContact"
            },
            "description": "Individuals representing the carrier to whom the booking should be sent. These contacts are not notify parties nor any individuals working with or on behalf of the shipper."
          },
          "carrierResponseMethod": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CarrierResponseMethod"
              }
            ],
            "description": "Carrier expected to answer by API/EDI or email",
            "default": "EMAIL"
          },
          "carrierRejectionNotes": {
            "maxLength": 300,
            "type": "string",
            "description": "A free-text space for the carrier to provide extra information as to why they may reject the booking request."
          },
          "carrierProvidedIdentifiers": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "description": "Carrier-supplied identifiers for the shipment to be transported. Fully mutable."
          },
          "capacityProviderReferenceKeys": {
            "maxItems": 25,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "A capacity-provider supplied list of custom key-value list pairs relevant to the booking which are shared with the shipper and will be used to initiate tracking within the project44 platform on top of shipper provided reference keys. If there is more than 25 reference keys in total, then excessive reference keys from this list will be omitted from the tracking initiation."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The datetime when the booking was created.",
            "format": "date-time"
          },
          "expirationDateTime": {
            "type": "string",
            "description": "The datetime of expiration for this request from the shipper to the carrier. A timezone offset is required.",
            "format": "date-time"
          },
          "fuelSurchargeRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the fuel surcharge component of the bookings rate itemized separately from total rate."
          },
          "id": {
            "type": "string",
            "description": "The project44-generated identifier for the booking.",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The datetime when the booking was last updated.",
            "format": "date-time"
          },
          "lastAcceptedDateTime": {
            "type": "string",
            "description": "The datetime when the booking was last accepted.",
            "format": "date-time"
          },
          "masterShipmentId": {
            "type": "string",
            "description": "Once `BOOKED`, the booking initiates a tracked shipment within project44. With this identifier, the shipper may seek the trackable shipment through the rest of the project44 platform.",
            "format": "uuid"
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "rateIdentifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RateIdentifier"
            },
            "description": "A list of at least one identifier as reference to the original source of the rate applicable to the booking. Typically a spot quote or a contract ID."
          },
          "routeSegmentIds": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "description": "List of route-segment ids which apply to the booking."
          },
          "routeSegments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteSegmentWithStops"
            },
            "description": "A list of locations from/to which the shipment load is expected to be transported, organized as pairs."
          },
          "rejectionReason": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingRejectionReason"
              }
            ],
            "description": "Descriptive information as to why a carrier could not accept a booking, if applicable."
          },
          "shipmentId": {
            "type": "string",
            "description": "The project44-generated identifier for the shipment which parents the booking. Optional when created with a Shipment in one request. Required when creating a booking separately.",
            "format": "uuid"
          },
          "shipmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentDetails"
            },
            "description": "Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body."
          },
          "shipperContactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Contact method to reach the shipper making the booking request."
          },
          "shippingDetails": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/BookingTruckloadShippingDetails"
              },
              {
                "$ref": "#/components/schemas/OceanShippingDetails"
              },
              {
                "$ref": "#/components/schemas/AirShippingDetails"
              }
            ],
            "description": "Information about how a load should be handled in transportation, specific to mode; When carrier respond to booking, this field also contains specific carrier's response information."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingStatus"
              }
            ],
            "description": "A descriptive state of the booking; Starting as `PROCESSING` when created, this booking may be `BOOKED`, `UNDER_REVIEW`, or `REJECTED by the carrier, and `CANCELLED` by the shipper. Or it may `EXPIRE` if it remains in the `PROCESSING` or `UNDER_REVIEW` states beyond its set expiration datetime.",
            "default": "PROCESSING"
          },
          "shipmentIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "description": "Shipper-supplied identifiers for the shipment to be transported. Passed through from the parenting shipment and shared with the carrier."
          },
          "totalRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the rate for transporting the load to the stops specified in the booking."
          },
          "transportationMode": {
            "$ref": "#/components/schemas/TransportationMode"
          }
        },
        "description": "A representation of a booking initiated by a shipper and accepted/rejected by a carrier.\n\nA booking describes the segments between locations to transport a load."
      },
      "BookingCapacityProviderIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CapacityProviderIdentifierType"
              }
            ],
            "description": "The type of identifier provided to distinguish the Capacity Provider."
          },
          "value": {
            "type": "string",
            "description": "Capacity Provider identifier."
          }
        },
        "description": "A Capacity Provider identifier object used to identify a carrier or a broker responsible for transporting\na shipment, containing two key-value pairs: type and value."
      },
      "BookingContact": {
        "required": [],
        "type": "object",
        "properties": {
          "companyName": {
            "type": "string",
            "description": "Name of the Company with whom the Contact is associated."
          },
          "email": {
            "type": "string",
            "description": "The Contact's email address.",
            "format": "email"
          },
          "familyName": {
            "type": "string",
            "description": "The Contact's last or family name."
          },
          "givenName": {
            "type": "string",
            "description": "The Contact's first or given name."
          },
          "mobilePhoneNumber": {
            "type": "string",
            "description": "The Contact's mobile phone number."
          },
          "phoneNumber": {
            "type": "string",
            "description": "The Contact's work or other primary phone number."
          }
        }
      },
      "BookingEBOLContact": {
        "required": [],
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email address of the location's contact person.",
            "format": "email"
          },
          "name": {
            "type": "string",
            "description": "Name of the location's contact person."
          },
          "phone": {
            "type": "string",
            "description": "Ten digit phone number, without country code and/or dashes, for the destination location's contact person."
          },
          "phoneExt": {
            "type": "string",
            "description": "Phone extension for the location's contact person."
          }
        }
      },
      "BookingEBOLHandlingUnit": {
        "required": [],
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "Number of handling units being described."
          },
          "dimensionsUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DimensionsUnit"
              }
            ],
            "description": "The unit of measurement for dimensions. Defaults to Inches (Imperial) if not passed.Valid Values: Inches or Centimeters."
          },
          "height": {
            "type": "integer",
            "description": "The height of the handling units being described."
          },
          "length": {
            "type": "integer",
            "description": "The length of the handling units being described."
          },
          "lineItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingLineItem"
            },
            "description": "The list of line items related to the shipment."
          },
          "stackable": {
            "type": "boolean",
            "description": "Identifies whether or not the freight being described can be stacked on one another.",
            "default": false
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HandlingUnitTypeCode"
              }
            ],
            "description": "Type of the handling units being described."
          },
          "tareWeight": {
            "type": "integer",
            "description": "Weight of the skids/pallets/slips used in the shipment."
          },
          "weight": {
            "type": "integer",
            "description": "Total weight for the specified handling units."
          },
          "weightUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLWeightUnit"
              }
            ],
            "description": "The unit of measurement for weight. Defaults to Pounds (Imperial) if not passed.",
            "default": "Pounds"
          },
          "width": {
            "type": "integer",
            "description": "The width of the handling units being described."
          }
        }
      },
      "BookingEBOLLocation": {
        "required": [],
        "type": "object",
        "properties": {
          "account": {
            "type": "string",
            "description": "Company's account number/id."
          },
          "address1": {
            "type": "string",
            "description": "Primary Address line for the location."
          },
          "address2": {
            "type": "string",
            "description": "Secondary Address line for the location."
          },
          "city": {
            "type": "string",
            "description": "City Name for the location."
          },
          "country": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CountryCode"
              }
            ],
            "description": "Three letter country code for the destination location."
          },
          "contact": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLContact"
              }
            ],
            "description": "Object containing contact details for the location."
          },
          "locationId": {
            "type": "string",
            "description": "Company's location id."
          },
          "name": {
            "type": "string",
            "description": "Company name associated with the location."
          },
          "postalCode": {
            "maxLength": 6,
            "minLength": 5,
            "type": "string",
            "description": "The 5-digit (or 6-characters for Canada) zip code for the destination location."
          },
          "stateProvince": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StateProvinceCode"
              }
            ],
            "description": "Two letter state/province code for the destination location."
          }
        }
      },
      "BookingEBOLWeightUnit": {
        "enum": [
          "Pounds",
          "Kilograms"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "BookingHandlingUnit": {
        "required": [],
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Free text space to describe the handling unit."
          },
          "dimensions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Dimensions"
              }
            ],
            "description": "The physical dimensions of the handling unit. Take care that this should reference the per quantity size of the chosen handling unit type."
          },
          "freightClass": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FreightClass"
              }
            ],
            "description": "Freight class of this handling unit. Required for LTL shipments only."
          },
          "handlingUnitType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HandlingUnitType"
              }
            ],
            "description": "The packaging used to handle the unit during transport."
          },
          "hazmatDetail": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HazmatDetail"
              }
            ],
            "description": "Provides important information about the hazardous materials to be transported, as required by theUS Department of Transportation (DOT). Only required for shipment requests."
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Item"
            },
            "description": "The items for this handling unit, if applicable."
          },
          "monetaryValue": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "The monetary value of the handling unit."
          },
          "nmfcItemCode": {
            "type": "string",
            "description": "NMFC prefix code for all packages composing this line item."
          },
          "nmfcSubCode": {
            "type": "string",
            "description": "NMFC suffix code for all packages composing this line item."
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of the handling unit type that is specified below."
          },
          "stackable": {
            "type": "boolean",
            "description": "Whether the packages composing are stackable or not.",
            "default": false
          },
          "weight": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingWeight"
              }
            ],
            "description": "The weight of the handling unit. Take care that this should reference the per quantity weight of the chosen handling unit type."
          }
        },
        "description": "Handling units managed by the shipper to be transported by the carrier."
      },
      "BookingLineItem": {
        "required": [],
        "type": "object",
        "properties": {
          "classification": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ClassificationCode"
              }
            ],
            "description": "Classification of the line item being described."
          },
          "description": {
            "type": "string",
            "description": "Description of the freight being described."
          },
          "hazardous": {
            "type": "boolean",
            "description": "Identifies whether or not the freight being described contains hazardous materials."
          },
          "hazardousDescription": {
            "type": "string",
            "description": "Conditionally required when 'hazardous' is 'true'. Provides a detailed description of the hazardous item.Example: UN 1090, Acetone, 3, PG II"
          },
          "hazardousDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HazardousDetails"
              }
            ],
            "description": "Details related to the hazardous line item."
          },
          "nmfc": {
            "type": "string",
            "description": "NMFC code of the freight being described."
          },
          "nmfcSub": {
            "type": "string",
            "description": "The Sub value for the NMFC of the freight being described."
          },
          "pieces": {
            "type": "integer",
            "description": "Number of individual pieces for the line item being described."
          },
          "packagingType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackagingTypeCode"
              }
            ],
            "description": "Packaging type for the individual pieces of the line item being described."
          },
          "weight": {
            "type": "integer",
            "description": "Total weight for the specified line item."
          },
          "weightUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLWeightUnit"
              }
            ],
            "description": "The unit of measurement for weight. Defaults to Pounds (Imperial) if not passed.Valid Values: Pounds or Kilograms.",
            "default": "Pounds"
          }
        }
      },
      "BookingLocation": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingLocationIdentifier"
            }
          },
          "name": {
            "type": "string"
          },
          "timeZone": {
            "type": "string"
          }
        }
      },
      "BookingLocationIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/LocationIdentifierType"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "BookingPage": {
        "required": [],
        "type": "object",
        "properties": {
          "paginationInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaginationInfo"
              }
            ],
            "description": "Pagination information about a collection of resources."
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Booking"
            },
            "description": "List of resources contained on this page."
          }
        },
        "description": "A paginated response containing results and information about the current page."
      },
      "BookingParty": {
        "required": [],
        "type": "object",
        "properties": {
          "addressInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              }
            ],
            "description": "Address of the listed party."
          },
          "contactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Individual contact information for the party."
          },
          "identifyingCodes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IdentifyingCodes"
              }
            ],
            "description": "DCSA ocean standard identifying codes for the party."
          },
          "locationIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/BookingLocationIdentifier"
            },
            "type": "array",
            "description": "Identifiers for the location of the party."
          },
          "partyType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PartyType"
              }
            ],
            "description": "The relationship the shipper has to the party, relevant to the shipment."
          },
          "vatNumber": {
            "type": "string",
            "description": "Optional, VAT number of the listed party, if applicable."
          }
        }
      },
      "BookingRejection": {
        "required": [],
        "type": "object",
        "properties": {
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "Free text space to supply extra detail regarding why the carrier may not be able to accept a particular booking from a shipper."
          },
          "reason": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingRejectionReason"
              }
            ],
            "description": "The codified reason why a carrier would reject a booking from a carrier."
          }
        }
      },
      "BookingRejectionReason": {
        "enum": [
          "COST_NOT_AGREED",
          "SHORT_ON_STAFF",
          "NOT_WITHIN_SCOPE",
          "TRANSIT_TIME_TOO_SHORT",
          "REQUESTED_EQUIPMENT_NOT_AVAILABLE",
          "OTHER"
        ],
        "type": "string",
        "description": "The reason a carrier may opt not to accept a booking from a shipper."
      },
      "BookingResponse": {
        "required": [],
        "type": "object",
        "properties": {
          "details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OceanBookingResponseDetails"
              },
              {
                "$ref": "#/components/schemas/TruckloadBookingResponseDetails"
              }
            ],
            "description": "Further response details applicable to the booking."
          },
          "routeSegments": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteSegmentResponse"
            },
            "description": "List of the accepted dates to travel the route-segments requested by the shipper. All of the route-segments requested by the shipper in the booking must be included."
          },
          "referenceKeys": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "maxItems": 25,
            "description": "A capacity-provider supplied list of custom key-value list pairs relevant to the booking which are shared with the shipper and will be used to initiate tracking within the project44 platform on top of shipper provided reference keys. If there is more than 25 reference keys in total, then excessive reference keys from this list will be omitted from the tracking initiation."
          },
          "shipmentIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "description": "Methods for identifying the shipment; usually a BOOKING_NUMBER or BOL."
          }
        },
        "description": "The carrier's approval of a booking.\n\nThe carrier should supply any identifiers they have for the shipment in their response."
      },
      "BookingSourceMethod": {
        "enum": [
          "API",
          "WEBAPP"
        ],
        "type": "string",
        "description": "Method by which a shipper initiates a request for a booking."
      },
      "BookingStatus": {
        "enum": [
          "PROCESSING",
          "UNDER_REVIEW",
          "BOOKED",
          "REJECTED",
          "CANCELLED",
          "EXPIRED"
        ],
        "type": "string",
        "description": "A descriptive state for a booking.\nBookings start out in a `PROCESSING` state, only to be `BOOKED` or `REJECTED` by a carrier.\nA booking may enter the `UNDER_REVIEW` state after `PROCESSING` if the response must be polled after request.\nThe state may shift to `CANCELLED` due to actions caused by either party in any state.\nA booking is `EXPIRED` if it sits in the `PROCESSING` or `UNDER_REVIEW` status\nupon the time which it is set to expire."
      },
      "BookingTruckloadShippingDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "flatbedType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FlatbedType"
              }
            ],
            "description": "The sub-equipment type of flatbed. Only applicable, and required, with a FLATBED trailer type."
          },
          "loadPreference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TruckLoadPreferenceType"
              }
            ],
            "description": "The preferred load occupancy of the truck."
          },
          "trailerType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TrailerType"
              }
            ],
            "description": "The equipment type of the trailer."
          },
          "trailerDetails": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FlatbedType"
              },
              {
                "$ref": "#/components/schemas/multi_modal_booking_service_public__shipping_details__truckload__ContainerType"
              },
              {
                "$ref": "#/components/schemas/MegaType"
              },
              {
                "$ref": "#/components/schemas/RefrigeratedTrailerDetails"
              }
            ],
            "description": "Optional details if requested trailer is of FLATBED, MEGA, CONTAINER or REFRIGERATED type."
          },
          "trailerLength": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Length"
              }
            ],
            "description": "Total requested trailer length in feet or meters; must not exceed 53 Feet or 17 meters."
          },
          "trailerVolume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "Total requested Trailer volume"
          }
        }
      },
      "BookingWeight": {
        "required": [],
        "type": "object",
        "properties": {
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WeightUnit"
              }
            ],
            "description": "The unit of measurement for this weight."
          },
          "value": {
            "minimum": 0,
            "type": "number",
            "description": "The numeric decimal value of this weight."
          }
        }
      },
      "CallBeforeArrivalAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "CALL_BEFORE_ARRIVAL"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for call before arrival to a stop service."
      },
      "CancelAppointmentResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the cancellation operation",
            "example": "SUCCESS"
          }
        }
      },
      "CapacityProvider": {
        "properties": {
          "capacityProviderIdentifiers": {
            "description": "A list of capacity provider identifiers that can be used to reference this capacity provider.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderIdentifier"
            },
            "type": "array"
          },
          "name": {
            "description": "The name of this capacity provider.",
            "type": "string"
          },
          "supportedServices": {
            "description": "A list of services by transportation mode supported by this capacity provider within project44.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderService"
            },
            "type": "array"
          },
          "type": {
            "description": "The type of this capacity provider, either carrier or 3PL/broker.",
            "enum": [
              "CARRIER",
              "BROKER"
            ],
            "type": "string"
          }
        },
        "title": "CapacityProvider",
        "type": "object"
      },
      "CapacityProviderAccount": {
        "description": "The capacity provider account that was used for authentication with the capacity provider's API.",
        "properties": {
          "code": {
            "description": "The code for the requested capacity provider account that was used for authentication with the capacity provider's API.",
            "type": "string"
          }
        },
        "title": "CapacityProviderAccount",
        "type": "object"
      },
      "CapacityProviderAccountFieldDefinition": {
        "properties": {
          "code": {
            "description": "The project44 code for this field. This is the name of the field within CapacityProviderAccountInfo -- e.g., 'credential1' or 'accountFlag1'.",
            "type": "string"
          },
          "constraint": {
            "description": "The constraints on this field -- whether it is required, conditionally required, or optional. If a field is not applicable to an account definition, it won't show up at all in the list.",
            "enum": [
              "REQUIRED",
              "CONDITIONALLY_REQUIRED",
              "OPTIONAL"
            ],
            "type": "string"
          },
          "name": {
            "description": "The display name of this field. For capacity-provider-specific fields like 'credential1', this name will be what the capacity provider calls this field -- e.g., 'Authentication Key' or 'Login Name'.",
            "type": "string"
          }
        },
        "title": "CapacityProviderAccountFieldDefinition",
        "type": "object"
      },
      "CapacityProviderAccountGroup": {
        "description": "The requested capacity provider account group containing the account used for authentication with the capacity provider's API.",
        "properties": {
          "accounts": {
            "description": "Capacity provider accounts used for authentication with the capacity providers' APIs. For quoting, defaults to all accounts within the account group. For shipment, shipment status, and image, one and only one account is required.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccount"
            },
            "type": "array"
          },
          "code": {
            "description": "The code for the capacity provider account group that contains all accounts against which an operation is to be performed. Capacity provider account groups are set up through the project44 Self-Service Portal. If no key is specified, the 'Default' account group will be used.",
            "type": "string"
          }
        },
        "title": "CapacityProviderAccountGroup",
        "type": "object"
      },
      "CapacityProviderAccountGroupInfo": {
        "description": "The details necessary to get or instantiate a new capacity provider group.",
        "properties": {
          "code": {
            "description": "The unique, user-provided code used to identify this account group. Typically, an account group will correspond to a single customer or a single customer location. Account group codes are provided in shipment lifecycle APIs to identify a particular account. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.",
            "type": "string"
          },
          "id": {
            "description": "The project44-generated id of the capacity provider account group. This id may not be provided when creating a capacity provider account group, but it is required when updating one or when creating or updating a capacity provider account set.",
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "description": "The user-provided name to be assigned to this group.  This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.",
            "type": "string"
          }
        },
        "title": "CapacityProviderAccountGroupInfo",
        "type": "object"
      },
      "CapacityProviderAccountGroupInfoCollection": {
        "description": "A collection of details necessary to get or instantiate a new capacity provider group.",
        "properties": {
          "groups": {
            "description": "List of multiple capacity provider account groups.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
            },
            "type": "array"
          }
        },
        "title": "CapacityProviderAccountGroupInfoCollection",
        "type": "object"
      },
      "CapacityProviderAccountInfo": {
        "description": "Capacity provider account information.",
        "properties": {
          "accountDefinitionIdentifier": {
            "description": "Capacity provider account definition identifier is used to distinguish capacity provider accounts when a specific capacity provider has more then one account definition for different services. Use the \"Capacity Provider Metadata\" API to get account definition information for a capacity provider.",
            "type": "string"
          },
          "accountFlag1": {
            "description": "A boolean flag related to the your account with the capacity provider, defined by the applicable capacity provider account definition (e.g., for UPGF, this is 'enable density-based rating').",
            "type": "boolean"
          },
          "accountNumber1": {
            "description": "The first account number with the capacity provider if this capacity provider account type has account numbers. This may be a bill-to account number, a shipper account number, a consignee account number, or some other account number.",
            "type": "string"
          },
          "accountNumber2": {
            "description": "The second account number with the capacity provider if this capacity provider account type has account numbers. This may be a bill-to account number, a shipper account number, a consignee account number, or some other account number.",
            "type": "string"
          },
          "billToLocationId": {
            "description": "The project44-generated id of the bill-to location. Locations can be created, updated, and retrieved through the location management API.",
            "type": "string"
          },
          "credential1": {
            "description": "The first password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these.  This field will not appear in any response object.",
            "type": "string"
          },
          "credential2": {
            "description": "The second password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these.",
            "type": "string"
          },
          "credential3": {
            "description": "The third password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these.",
            "type": "string"
          },
          "directionCode": {
            "description": "The direction or shipment terms of the your account with the capacity provider -- the party responsible for the shipment.",
            "enum": [
              "SHIPPER",
              "CONSIGNEE",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "enableDirectionOverride": {
            "description": "Whether or not direction for this capacity provider account can be overridden in an API request. The direction for some capacity provider accounts should never be overridden, while others need to be changed depending on the origin and destination of a shipment or other factors.  Whether this override should be enabled depends primarily on the capacity provider. (default: 'false')",
            "type": "boolean"
          },
          "enablePaymentTermsOverride": {
            "description": "Whether or not payment terms for this capacity provider account can be overridden in an API request. The payment terms for some capacity provider accounts should never be overridden, while others need to be changed depending on the origin and destination of a shipment or other factors.  Whether this override is enabled depends primarily on the capacity provider. (default: 'false')",
            "type": "boolean"
          },
          "id": {
            "description": "The project44-generated id of the capacity provider account. This id may not be provided when creating a capacity provider account, but it is required when updating one.",
            "format": "int64",
            "type": "integer"
          },
          "oAuth2LoginUrl": {
            "type": "string"
          },
          "oAuth2SignupUrl": {
            "type": "string"
          },
          "paymentTermsCode": {
            "description": "The payment terms of the customer's account with the capacity provider -- the party responsible for payment.",
            "enum": [
              "PREPAID",
              "COLLECT",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "username1": {
            "description": "The username of the account, if this capacity provider account type has a username.",
            "type": "string"
          }
        },
        "title": "CapacityProviderAccountInfo",
        "type": "object"
      },
      "CapacityProviderAccountInfoDefinition": {
        "properties": {
          "accountDefinitionIdentifier": {
            "description": "The project44 account definition identifier for this capacity provider account definition, to be passed in the CapacityProviderAccountInfo to identify this account.",
            "type": "string"
          },
          "accountFieldDefinitions": {
            "description": "A list of account fields and their definitions, indicating which fields on CapacityProviderAccountInfo are required, conditionally required, and optional, and what the capacity provider itself calls these fields to make locating the information within the capacity provider's system easy. Only those fields that may be passed in CapacityProviderAccountInfo for this specific account definition and capacity provider are listed here.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccountFieldDefinition"
            },
            "type": "array"
          },
          "name": {
            "description": "The project44 name for this account for reference or display purposes.",
            "type": "string"
          },
          "supportedServices": {
            "description": "A list of supported services by transportation mode supported by this capacity provider via this specific account type. Capacity providers that have multiple account definitions often use each for a distinct subset of their supported services -- e.g., one account definition may be for volume LTL rating, another may be for LTL imaging, and a third may be for their remaining supported services.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderService"
            },
            "type": "array"
          }
        },
        "title": "CapacityProviderAccountInfoDefinition",
        "type": "object"
      },
      "CapacityProviderAccountInfos": {
        "description": "Contains one or more account definitions for a capacity provider.",
        "properties": {
          "accounts": {
            "description": "Only one account for each of the capacity provider's account definitions may be provided. On update, accounts in this list may reference ids of existing accounts or may be completely new accounts without ids if replacement is desired. Use the \"Capacity Provider Metadata\" API to get account definition information for a capacity provider. This API will indicate all fields that must be specified on CapacityProviderAccountInfo for each account type for a given capacity provider.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccountInfo"
            },
            "type": "array"
          },
          "capacityProviderIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "code": {
            "description": "The code identifier for the account set. This must be unique to the capacity provider account group this account set resides in.",
            "type": "string"
          },
          "group": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroupInfo"
          },
          "id": {
            "description": "The project44-generated id of the capacity provider account set. This id may not be provided when creating a capacity provider account set, but it is required when updating one.",
            "format": "int64",
            "type": "integer"
          }
        },
        "title": "CapacityProviderAccountInfos",
        "type": "object"
      },
      "CapacityProviderAccountInfosCollection": {
        "description": "A collection of one or more account definitions for a capacity provider.",
        "properties": {
          "accounts": {
            "description": "List of capacity provider accounts, possible across multiple account groups.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccountInfos"
            },
            "type": "array"
          }
        },
        "title": "CapacityProviderAccountInfosCollection",
        "type": "object"
      },
      "CapacityProviderCollection": {
        "properties": {
          "capacityProviders": {
            "description": "A list of all capacity providers matching the query.",
            "items": {
              "$ref": "#/components/schemas/CapacityProvider"
            },
            "type": "array"
          }
        },
        "title": "CapacityProviderCollection",
        "type": "object"
      },
      "CapacityProviderIdentifier": {
        "description": "A capacity provider identifier object.",
        "properties": {
          "type": {
            "description": "Capacity provider identifier type.",
            "enum": [
              "SCAC",
              "DOT_NUMBER",
              "MC_NUMBER",
              "P44_EU",
              "SYSTEM",
              "P44_GLOBAL",
              "VAT"
            ],
            "type": "string"
          },
          "value": {
            "description": "Capacity provider identifier value.",
            "type": "string"
          }
        },
        "title": "CapacityProviderIdentifier",
        "type": "object"
      },
      "CapacityProviderIdentifierType": {
        "enum": [
          "FFW_SCAC",
          "CARRIER_SCAC",
          "DOT_NUMBER",
          "MC_NUMBER",
          "P44_EU",
          "SYSTEM",
          "P44_GLOBAL"
        ],
        "type": "string",
        "description": "The type of identifier provided to distinguish the Capacity Provider."
      },
      "CapacityProviderMetadata": {
        "properties": {
          "accountDefinitions": {
            "description": "A list of capacity provider account definitions for this capacity provider. Each of these corresponds to a CapacityProviderAccountInfo that could be passed as part of a CapacityProviderAccountInfos when creating a capacity provider account for this capacity provider via the capacity provider account management APIs.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderAccountInfoDefinition"
            },
            "type": "array"
          },
          "capacityProvider": {
            "$ref": "#/components/schemas/CapacityProvider"
          }
        },
        "title": "CapacityProviderMetadata",
        "type": "object"
      },
      "CapacityProviderService": {
        "properties": {
          "mode": {
            "description": "The transportation mode of this service provided by a capacity provider.",
            "enum": [
              "PARCEL",
              "LTL",
              "VOLUME_LTL",
              "TRUCKLOAD",
              "OCEAN",
              "RAIL"
            ],
            "type": "string"
          },
          "type": {
            "description": "The type of this service provided by a capacity provider.",
            "enum": [
              "RATING",
              "DISPATCH",
              "TRACKING",
              "IMAGING"
            ],
            "type": "string"
          }
        },
        "title": "CapacityProviderService",
        "type": "object"
      },
      "CapacityResponse": {
        "type": "object",
        "properties": {
          "availableSlots": {
            "type": "array",
            "description": "List of available slots with section information",
            "items": {
              "$ref": "#/components/schemas/AvailableSlot"
            }
          },
          "bookedSlots": {
            "type": "array",
            "description": "List of booked slots with shipment information",
            "items": {
              "$ref": "#/components/schemas/BookedSlot"
            }
          },
          "capacityDate": {
            "type": "string",
            "format": "date",
            "description": "Date for the capacity information",
            "example": "2024-01-15"
          },
          "siteCode": {
            "type": "string",
            "description": "Code identifying the site",
            "example": "SITE001"
          },
          "totalSlots": {
            "type": "integer",
            "description": "Total number of slots available for the date",
            "example": 20
          },
          "totalBookedSlots": {
            "type": "integer",
            "description": "Total number of booked slots for the date",
            "example": 8
          },
          "totalCapacity": {
            "type": "integer",
            "description": "Total available capacity (totalSlots - bookedSlots - unplannedShipments)",
            "example": 10
          },
          "unplannedShipmentsCount": {
            "type": "integer",
            "description": "Number of unplanned shipments for the date",
            "example": 2
          }
        }
      },
      "CargoMeasurements": {
        "type": "object",
        "properties": {
          "dimensions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Dimensions"
              }
            ],
            "description": "The height, length, width dimensions of the cargo"
          },
          "volume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "The volume of the cargo"
          },
          "weight": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingWeight"
              }
            ],
            "description": "The weight of the cargo"
          }
        }
      },
      "CarrierEvent": {
        "required": [],
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "A human readable description of this event."
          },
          "dateTime": {
            "type": "string",
            "description": "The actual time when this event occurred.  Should only be populated for events that have already happened.",
            "format": "date-time"
          },
          "estimatedDateTime": {
            "type": "string",
            "description": "The estimated time that this event is likely to occur.",
            "format": "date-time"
          },
          "location": {
            "$ref": "#/components/schemas/CarrierLocation"
          },
          "plannedDateTime": {
            "type": "string",
            "description": "The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.",
            "format": "date-time"
          },
          "plannedEndDateTime": {
            "type": "string",
            "description": "The end of the planned window of time for the event. Only valid for `ARRIVAL_AT_STOP` events.",
            "format": "date-time"
          },
          "source": {
            "type": "string",
            "description": "The source providing event information.",
            "enum": [
              "UNKNOWN",
              "CARRIER",
              "CONTRACT"
            ]
          },
          "sourceIdentifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Identifies the specific carrier or data provider from which this event was sourced.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "type": {
            "type": "string",
            "description": "The type of event that occurred.",
            "enum": [
              "UNKNOWN",
              "TRACKING_INITIATE",
              "TRACKING_START",
              "ARRIVAL_AT_STOP",
              "DEPARTURE_FROM_STOP",
              "LOAD_ONTO_VEHICLE",
              "UNLOAD_FROM_VEHICLE",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_END_BY_USER",
              "TRACKING_COMPLETE",
              "GATE_IN",
              "GATE_OUT",
              "FLIGHT_BOOKING",
              "MANIFEST",
              "RECEIVE_FROM_SHIPPER",
              "CONSIGNEE_NOTIFY",
              "DELIVERY",
              "WARNING",
              "EXCEPTION",
              "TRACKING_STOP",
              "EXCEPTION_LATE_DEPARTURE",
              "EXCEPTION_MISSED_CONNECTION",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT_FULL",
              "LOAD",
              "DISCHARGE",
              "EXCEPTION_DELAYED",
              "EXCEPTION_DELIVERY_MISSED",
              "EXCEPTION_HELD",
              "EXCEPTION_PICKUP_MISSED",
              "AVAILABLE",
              "ENTERED_GEOFENCE",
              "EXITED_GEOFENCE",
              "INFO",
              "OUT_FOR_DELIVERY",
              "PICKED_UP",
              "RETURN_TO_SENDER",
              "TRACKING_FAILED",
              "UNAUTHORIZED",
              "PICKUP_MISSED",
              "SURVEY",
              "HELD",
              "CLEAN_TRUCK_FEE_CLEARANCE",
              "CLEAN_TRUCK_FEE_HOLD",
              "OTHER_HOLD",
              "OTHER_HOLD_CLEARANCE",
              "TERMINAL_CLEARANCE",
              "TERMINAL_HOLD",
              "TRAFFIC_MITIGATION_FEE_CLEARANCE",
              "TRAFFIC_MITIGATION_FEE_HOLD",
              "RELEASE",
              "DELAYED",
              "DELIVERY_MISSED",
              "ENTERED_INNER_GEOFENCE",
              "EXITED_INNER_GEOFENCE",
              "ENTERED_OUTER_GEOFENCE",
              "EXITED_OUTER_GEOFENCE",
              "ENTERED_FINAL_GEOFENCE",
              "EXITED_FINAL_GEOFENCE",
              "IDLE",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "DISPATCH",
              "CUSTOMS_HOLD",
              "CUSTOMS_CLEARANCE",
              "CUSTOMS_DOCS_FILING",
              "CUSTOMS_TRANSIT_DOCS_ISSUED",
              "CUSTOMS_TRANSIT_DOCS_CLOSED",
              "CARRIER_HOLD",
              "RECEIVE_FROM_CARRIER",
              "ISSUE_FREIGHT_BILL",
              "FREIGHT_ON_HAND",
              "READY_FOR_CARRIAGE",
              "LAST_FREE_DAY",
              "MISSING_CARRIER",
              "STUFF",
              "STRIP",
              "SEAL_INSPECTION",
              "SEAL_REMOVAL",
              "SEAL_RESEAL",
              "HANDOVER",
              "DOCUMENT_ADD",
              "DOCUMENT_REMOVE",
              "REMOVE_FROM_BOOKING",
              "COST_UPDATE",
              "SHARING_STOPPED",
              "ROLLED_OVER",
              "BAD_ORDER",
              "BAD_ORDER_RELEASE"
            ]
          }
        },
        "description": "An event is something that occurs at a point in time for a shipment."
      },
      "CarrierEventsAndPositions": {
        "type": "object",
        "properties": {
          "events": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Events that occurred for a shipment.",
            "items": {
              "$ref": "#/components/schemas/CarrierEvent"
            }
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Any standardized 3rd party identifier. Can be used to identify a shipment, freight, vehicle, carrier, or other freight entity.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "positions": {
            "maxItems": 500,
            "minItems": 0,
            "type": "array",
            "description": "Locations where a shipment has been recorded.",
            "items": {
              "$ref": "#/components/schemas/CarrierPosition"
            }
          }
        },
        "description": "Contains shipment information like identifiers, events, and positions."
      },
      "CarrierLanePerformance": {
        "properties": {
          "carrier": {
            "$ref": "#/components/schemas/ConnectedCarrierContact"
          },
          "destinationMarket": {
            "description": "Destination market of lane. Market is defined as the 3ZIP in the United States, and the Level-2 administrative region (County/District) everywhere else.",
            "type": "string"
          },
          "last30DaysDeliveryScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 30 days that were delivered within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysPercentTracked": {
            "description": "Percentage of shipments in the past 30 days where tracking was initiated which received at least one tracking update",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysPickupScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 30 days that were picked up within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysShipmentVolume": {
            "description": "Number of shipments tracked in the past 30 days",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "last365DaysDeliveryScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 365 days that were delivered within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysPercentTracked": {
            "description": "Percentage of shipments in the past 365 days where tracking was initiated which received at least one tracking update",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysPickupScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 365 days that were picked up within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysShipmentVolume": {
            "description": "Number of shipments tracked in the past 365 days",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "originMarket": {
            "description": "Origin market of lane. Market is defined as the 3ZIP in the United States, and the Level-2 administrative region (County/District) everywhere else.",
            "type": "string"
          },
          "performanceByMonth": {
            "description": "Average monthly performance for the past 12 months",
            "items": {
              "$ref": "#/components/schemas/MonthlyCarrierPerformance"
            },
            "type": "array"
          }
        },
        "title": "CarrierLanePerformance",
        "type": "object"
      },
      "CarrierLanePerformanceCollection": {
        "properties": {
          "carrierLanePerformances": {
            "description": "List of responses",
            "items": {
              "$ref": "#/components/schemas/CarrierLanePerformance"
            },
            "type": "array"
          }
        },
        "title": "CarrierLanePerformanceCollection",
        "type": "object"
      },
      "CarrierLanePerformanceQuery": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/ConnectedCarrierIdentifier"
          },
          "destination": {
            "$ref": "#/components/schemas/Address"
          },
          "minimumDeliveryScheduleReliability": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days that were delivered within 2 hours of the scheduled time is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumPickupScheduleReliability": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days that were picked up within 2 hours of the scheduled time is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumTrackingPercentage": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days which received at least one tracking update is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumVolume": {
            "description": "Return only results where the number of shipments tracked in the past 365 days is above the given value",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "origin": {
            "$ref": "#/components/schemas/Address"
          },
          "sortBy": {
            "description": "Use the following metric to sort results. Defaults to <code>SHIPMENT_VOLUME</code>",
            "enum": [
              "SHIPMENT_VOLUME",
              "RECENT_SHIPMENT_VOLUME",
              "DELIVERY_SCHEDULE_RELIABILITY",
              "PICKUP_SCHEDULE_RELIABILITY",
              "PERCENT_TRACKED",
              "RECENT_PERCENT_TRACKED"
            ],
            "type": "string"
          },
          "sortDirection": {
            "description": "Sort results by ascending or descending values of the selected metric. Defaults to <code>DESC</code> (descending).",
            "enum": [
              "ASC",
              "DESC"
            ],
            "type": "string"
          }
        },
        "title": "CarrierLanePerformanceQuery",
        "type": "object"
      },
      "CarrierLocation": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "coordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "identifiers": {
            "type": "array",
            "description": "List of standard identifiers associated with this location.",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentStopLocationIdentifier"
            }
          },
          "name": {
            "type": "string",
            "description": "The name of the location."
          },
          "timeZone": {
            "type": "string",
            "description": "TZ database identifier of the time zone at the stop (https://www.iana.org/time-zones)"
          }
        },
        "description": "The location of a stop."
      },
      "CarrierMetrics": {
        "type": "object",
        "properties": {
          "carrierAssureScore": {
            "type": "number",
            "description": "Score for the carrier provided by the Carrier Assure API."
          },
          "carrierAssureGrade": {
            "type": "string",
            "description": "Grade for the carrier provided by the Carrier Assure API."
          },
          "onTimePercentage": {
            "type": "number",
            "description": "Share of shipments which were on-time."
          },
          "shipmentCount": {
            "type": "integer",
            "description": "Number of shipments considered in Calculations"
          },
          "trackingPercentage": {
            "type": "number",
            "description": "Share of shipments which had adequate tracking enabled."
          }
        }
      },
      "CarrierPerformance": {
        "properties": {
          "carrier": {
            "$ref": "#/components/schemas/ConnectedCarrierContact"
          },
          "last30DaysDeliveryScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 30 days that were delivered within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysPercentTracked": {
            "description": "Percentage of shipments in the past 30 days where tracking was initiated which received at least one tracking update",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysPickupScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 30 days that were picked up within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last30DaysShipmentVolume": {
            "description": "Number of shipments tracked in the past 30 days",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "last365DaysDeliveryScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 365 days that were delivered within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysPercentTracked": {
            "description": "Percentage of shipments in the past 365 days where tracking was initiated which received at least one tracking update",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysPickupScheduleReliability": {
            "description": "Percentage of tracked shipments in the past 365 days that were picked up within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "last365DaysShipmentVolume": {
            "description": "Number of shipments tracked in the past 365 days",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "performanceByMonth": {
            "description": "Average monthly performance for the past 12 months",
            "items": {
              "$ref": "#/components/schemas/MonthlyCarrierPerformance"
            },
            "type": "array"
          }
        },
        "title": "CarrierPerformance",
        "type": "object"
      },
      "CarrierPerformanceCollection": {
        "properties": {
          "carrierPerformances": {
            "description": "List of responses",
            "items": {
              "$ref": "#/components/schemas/CarrierPerformance"
            },
            "type": "array"
          }
        },
        "title": "CarrierPerformanceCollection",
        "type": "object"
      },
      "CarrierPerformanceQuery": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/ConnectedCarrierIdentifier"
          },
          "minimumDeliveryScheduleReliability": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days that were delivered within 2 hours of the scheduled time is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumPickupScheduleReliability": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days that were picked up within 2 hours of the scheduled time is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumTrackingPercentage": {
            "description": "Return only results where the percentage of tracked shipments in the past 365 days which received at least one tracking update is above the given value",
            "format": "int32",
            "type": "integer"
          },
          "minimumVolume": {
            "description": "Return only results where the number of shipments tracked in the past 365 days is above the given value",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "sortBy": {
            "description": "Use the following metric to sort results. Defaults to <code>SHIPMENT_VOLUME</code>",
            "enum": [
              "SHIPMENT_VOLUME",
              "RECENT_SHIPMENT_VOLUME",
              "DELIVERY_SCHEDULE_RELIABILITY",
              "PICKUP_SCHEDULE_RELIABILITY",
              "PERCENT_TRACKED",
              "RECENT_PERCENT_TRACKED"
            ],
            "type": "string"
          },
          "sortDirection": {
            "description": "Sort results by ascending or descending values of the selected metric. Defaults to <code>DESC</code> (descending).",
            "enum": [
              "ASC",
              "DESC"
            ],
            "type": "string"
          }
        },
        "title": "CarrierPerformanceQuery",
        "type": "object"
      },
      "CarrierPosition": {
        "required": [],
        "type": "object",
        "properties": {
          "dateTime": {
            "type": "string",
            "description": "The timestamp denoting when the shipment was detected at the given coordinates.",
            "format": "date-time"
          },
          "latitude": {
            "maximum": 90,
            "minimum": -90,
            "type": "number",
            "description": "The geographic latitude, using the WGS84 coordinate system.",
            "format": "float"
          },
          "longitude": {
            "maximum": 180,
            "minimum": -180,
            "type": "number",
            "description": "The geographic longitude, using the WGS84 coordinate system.",
            "format": "float"
          }
        },
        "description": "The geographic coordinates where a shipment was located at a given point in time."
      },
      "CarrierResponseMethod": {
        "enum": [
          "API",
          "EDI",
          "EMAIL"
        ],
        "type": "string",
        "description": "Method by which a carrier responds to bookings."
      },
      "CarrierRouteDiscovery": {
        "type": "object",
        "properties": {
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "A list of identifiers that the given route segments pertain to.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "routeSegments": {
            "maxItems": 50,
            "minItems": 0,
            "type": "array",
            "description": "The expected movements related to the given identifiers.",
            "items": {
              "$ref": "#/components/schemas/CarrierRouteSegment"
            }
          }
        },
        "description": "The route information for the given identifiers."
      },
      "CarrierRouteSegment": {
        "required": [],
        "type": "object",
        "properties": {
          "fromStop": {
            "$ref": "#/components/schemas/CarrierStopLocation"
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Identifiers relevant to this route segment.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "toStop": {
            "$ref": "#/components/schemas/CarrierStopLocation"
          },
          "transportationMode": {
            "type": "string",
            "description": "The transportation mode used to move the specified identifiers from the fromStop to the toStop.",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ]
          }
        },
        "description": "Describes the movement of the given identifiers from one stop to another."
      },
      "CarrierStopLocation": {
        "required": [],
        "type": "object",
        "properties": {
          "location": {
            "$ref": "#/components/schemas/CarrierLocation"
          },
          "type": {
            "type": "string",
            "description": "The type of the stop.",
            "enum": [
              "UNKNOWN",
              "ORIGIN",
              "DESTINATION",
              "TRANSFER",
              "OTHER",
              "PORT_OF_LOADING",
              "TRANSSHIPMENT_PORT",
              "PORT_OF_DISCHARGE",
              "PICKUP",
              "DELIVERY",
              "RETURN",
              "WAREHOUSE",
              "HUB",
              "AIRPORT",
              "ORIGIN_CFS",
              "DESTINATION_CFS"
            ]
          }
        },
        "description": "A shipment stop."
      },
      "ChainsAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "CHAINS"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuantityKind"
              }
            ],
            "description": "Count and size of chains."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which delineates the expected size and number of chains used in shipping."
      },
      "Charge": {
        "description": "An individual charge provided in a rate quote.",
        "properties": {
          "amount": {
            "description": "The actual amount charged by the capacity provider (adds into the total). This amount may be negative (e.g., for discounts).",
            "type": "number"
          },
          "amountInPreferredCurrency": {
            "description": "A list of individual charges making up the total, if provided, in the preferred currency requested. Also returned for alternate rate quotes.",
            "type": "number"
          },
          "code": {
            "description": "Code that identifies this line item charge. A list of charge codes used by project44 is provided in the API reference data section.",
            "type": "string"
          },
          "description": {
            "description": "Readable description of the line item charge, often originating from the capacity provider.",
            "type": "string"
          },
          "itemFreightClass": {
            "description": "If this is an item charge, the freight class of the line item, if provided. This field is not returned for volume LTL quotes.",
            "type": "string"
          },
          "itemWeight": {
            "description": "If this is an item charge, the weight of the line item, if provided.  If a preferred system of measurement was provided, the weight will be converted as necessary.",
            "type": "number"
          },
          "itemWeightUnit": {
            "description": "If this is an item charge, the weight measurement unit for the provided line item weight.  If a preferred system of measurement was provided, the weight will be converted as necessary.",
            "enum": [
              "LB",
              "KG"
            ],
            "type": "string"
          },
          "rate": {
            "description": "Rate used by the capacity provider to calculate this charge (e.g., an amount charged per lb, per piece, per mile, etc.). This rate may be negative (e.g., for discounts).",
            "type": "number"
          }
        },
        "title": "Charge",
        "type": "object"
      },
      "ClassificationCode": {
        "enum": [
          "50",
          "55",
          "60",
          "65",
          "70",
          "77.5",
          "85",
          "92.5",
          "100",
          "110",
          "125",
          "150",
          "175",
          "200",
          "250",
          "300",
          "400",
          "500"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "ClientApplication": {
        "type": "object",
        "description": "Contains the attributes of an OAuth 2.0 client application.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id of the client application, generated and assigned by project44. It is an alphanumeric id. In OAuth 2.0, this is referred to as the \"client_id\". This id is not considered a secret, but it is generally known only to you, your application, and project44, and is part of your application's credentials, along with the client secret, which are required to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this id is the \"username\" part of the base64-encoded Authorization header summary.",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Your name for the client application. Every application is required to have a name.",
            "example": "My Client Application"
          },
          "secret": {
            "type": "string",
            "description": "The secret part of the client application's credentials, generated and assigned by project44. In OAuth 2.0, this is referred to as the \"client_secret\". It cannot be retrieved again after the first time project44 returns it to you, but a new secret can be set for an application via the \"new-secret\" endpoint. It is confidential and should be stored encrypted at rest in a secure location for your application's use only. It is needed to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this secret is the \"password\" part of the base64-encoded Authorization header summary.",
            "readOnly": true
          }
        },
        "required": []
      },
      "ClientApplicationCollection": {
        "type": "object",
        "description": "Contains a list of client applications.",
        "properties": {
          "clientApplications": {
            "type": "array",
            "description": "The list of client applications registered in your project44 account.",
            "items": {
              "$ref": "#/components/schemas/ClientApplication"
            }
          }
        }
      },
      "Cod": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "description": "Amount to be received for the COD. Valid Formats: ##.## (2 decimal places only)."
          },
          "currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              }
            ],
            "description": "Optional attribute to indicate currency of declaredValue. Defaults to USD.",
            "default": "USD"
          },
          "customerCheckAcceptable": {
            "type": "boolean",
            "description": "Indicates whether or not a customer check or cash is acceptable."
          },
          "remitTo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RemitTo"
              }
            ],
            "description": "Required when accessorial code COD is present in the accessorial codes list."
          },
          "terms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CodTermCode"
              }
            ],
            "description": "Payment terms associated with the COD."
          }
        }
      },
      "CodeListName": {
        "type": "string",
        "enum": [
          "DID",
          "LEI",
          "DUNS"
        ],
        "description": "An enumeration."
      },
      "CodeListProvider": {
        "type": "string",
        "enum": [
          "WAVE",
          "CARX",
          "ESSD",
          "IDT",
          "BOLE",
          "EDOX",
          "IQAX",
          "SECR",
          "TRGO",
          "ETEU",
          "TRAC",
          "BRIT",
          "GSBN",
          "WISE",
          "GLEIF",
          "W3C",
          "DNB",
          "FMC",
          "DCSA",
          "ZZZ"
        ],
        "description": "An enumeration."
      },
      "CodTermCode": {
        "enum": [
          "Collect",
          "Prepaid"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Commodities": {
        "required": [],
        "type": "object",
        "properties": {
          "handlingUnits": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingEBOLHandlingUnit"
            },
            "description": "A list of the quantity of certain handling unit types."
          },
          "lineItemLayout": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LineItemLayoutType"
              }
            ],
            "description": "Valid values: Nested or Stacked.Nested: Indicates if the Handling Unit/Line Item relationship is known. If this value is used, each Line Item associated to a Handling Unit is conditionally required to be passed within that Handling Unit's object. Stacked: Indicates if the Handling Unit/Line Item relationship is not known. If this value is used, Line Items may passed within any Handling Unit object."
          }
        }
      },
      "ConnectedCarrierContact": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "identifiers": {
            "description": "Codes used to identify carrier",
            "items": {
              "$ref": "#/components/schemas/ConnectedCarrierIdentifier"
            },
            "type": "array"
          },
          "name": {
            "description": "Name of carrier",
            "type": "string"
          }
        },
        "title": "ConnectedCarrierContact",
        "type": "object"
      },
      "ConnectedCarrierIdentifier": {
        "description": "A capacity provider identifier object.",
        "properties": {
          "type": {
            "description": "${CapacityProviderIdentifier.apiModel.type.value}",
            "enum": [
              "SCAC",
              "DOT_NUMBER",
              "MC_NUMBER",
              "P44_EU",
              "P44_GLOBAL",
              "VAT_NUMBER"
            ],
            "type": "string"
          },
          "value": {
            "description": "${CapacityProviderIdentifier.apiModel.value.value}",
            "type": "string"
          }
        },
        "title": "ConnectedCarrierIdentifier",
        "type": "object"
      },
      "Contact": {
        "description": "Contact information.",
        "properties": {
          "companyName": {
            "description": "Company name.",
            "type": "string"
          },
          "contactName": {
            "description": "Contact name.  May be required for shipments.",
            "type": "string"
          },
          "email": {
            "description": "Email address.  May be required for shipments.",
            "type": "string"
          },
          "faxNumber": {
            "description": "Fax number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "faxNumberCountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          },
          "phoneNumber": {
            "description": "Phone number.  May be required  for shipments. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "phoneNumber2": {
            "description": "Alternate phone number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "phoneNumber2CountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          },
          "phoneNumberCountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          }
        },
        "title": "Contact",
        "type": "object"
      },
      "ContactReference": {
        "properties": {
          "contactId": {
            "description": "The project44-generated id of the contact. Contacts can be created, updated, and retrieved through the contact management API.",
            "type": "string"
          },
          "type": {
            "description": "Relationship of this contact to the location.",
            "type": "string"
          }
        },
        "required": [],
        "title": "ContactReference",
        "type": "object"
      },
      "ContainerDetails": {
        "properties": {
          "containerId": {
            "type": "string",
            "maxLength": 16,
            "minLength": 1,
            "description": "Container ID listed in `shipmentIdentifiers`."
          },
          "referenceKeys": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "maxItems": 25,
            "description": "A capacity-provider supplied list of custom key-value list pairs relevant to the container which are shared with the shipper."
          }
        },
        "type": "object",
        "required": []
      },
      "CountryCode": {
        "type": "string",
        "description": "Abbreviation of country (using ISO 3166 standards). (default: 'US')",
        "format": "enum",
        "enum": [
          "US",
          "CA",
          "MX",
          "AG",
          "BB",
          "BS",
          "BZ",
          "CR",
          "CU",
          "DM",
          "DO",
          "GD",
          "GT",
          "HN",
          "HT",
          "JM",
          "KN",
          "LC",
          "NI",
          "PA",
          "SV",
          "TT",
          "VC",
          "AI",
          "AW",
          "BL",
          "BM",
          "BQ",
          "CW",
          "GL",
          "GP",
          "KY",
          "MF",
          "MQ",
          "MS",
          "PM",
          "PR",
          "SX",
          "TC",
          "UM",
          "VG",
          "VI",
          "AT",
          "BE",
          "BG",
          "CY",
          "CZ",
          "DK",
          "DE",
          "EE",
          "ES",
          "FI",
          "FR",
          "GB",
          "GR",
          "HR",
          "HU",
          "IE",
          "IT",
          "LT",
          "LU",
          "LV",
          "MT",
          "NL",
          "PL",
          "PT",
          "RO",
          "SE",
          "SK",
          "SI",
          "CH",
          "IS",
          "LI",
          "NO",
          "AL",
          "ME",
          "MK",
          "RS",
          "TR",
          "AD",
          "AX",
          "BA",
          "BV",
          "BY",
          "FO",
          "GG",
          "GI",
          "IM",
          "IO",
          "JE",
          "MC",
          "MD",
          "SJ",
          "SM",
          "TF",
          "UA",
          "VA",
          "AE",
          "AF",
          "AM",
          "AZ",
          "BD",
          "BH",
          "BN",
          "BT",
          "CN",
          "GE",
          "HK",
          "ID",
          "IL",
          "IN",
          "IQ",
          "IR",
          "JO",
          "JP",
          "KG",
          "KH",
          "KP",
          "KR",
          "KW",
          "KZ",
          "LA",
          "LB",
          "LK",
          "MM",
          "MN",
          "MO",
          "MV",
          "MY",
          "NP",
          "OM",
          "PH",
          "PK",
          "PS",
          "QA",
          "RU",
          "SA",
          "SG",
          "SY",
          "TH",
          "TJ",
          "TL",
          "TM",
          "TW",
          "UZ",
          "VN",
          "YE",
          "AO",
          "BF",
          "BI",
          "BJ",
          "BW",
          "CD",
          "CF",
          "CG",
          "CI",
          "CM",
          "CV",
          "DJ",
          "DZ",
          "EG",
          "EH",
          "ER",
          "ET",
          "GA",
          "GH",
          "GM",
          "GN",
          "GQ",
          "GW",
          "HM",
          "KE",
          "KM",
          "LR",
          "LS",
          "LY",
          "MA",
          "MG",
          "ML",
          "MR",
          "MU",
          "MW",
          "MZ",
          "NA",
          "NE",
          "NG",
          "RE",
          "RW",
          "SC",
          "SD",
          "SH",
          "SL",
          "SN",
          "SO",
          "SS",
          "ST",
          "SZ",
          "TD",
          "TG",
          "TN",
          "TZ",
          "UG",
          "YT",
          "ZA",
          "ZM",
          "ZW",
          "AR",
          "BO",
          "BR",
          "CL",
          "CO",
          "EC",
          "FK",
          "GF",
          "GS",
          "GY",
          "PE",
          "PY",
          "SR",
          "UY",
          "VE",
          "AS",
          "AU",
          "CC",
          "CK",
          "CX",
          "FJ",
          "FM",
          "GU",
          "KI",
          "MH",
          "MP",
          "NC",
          "NF",
          "NR",
          "NU",
          "NZ",
          "PF",
          "PG",
          "PN",
          "PW",
          "SB",
          "TK",
          "TO",
          "TV",
          "VU",
          "WF",
          "WS",
          "AQ",
          "EL",
          "UK",
          "XK",
          "XS",
          "XI"
        ]
      },
      "CraneAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "CRANE"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for crane service."
      },
      "CreateBookedShipment": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 5,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers."
          },
          "bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateUpdateBooking"
            },
            "description": "A list of bookings related to the shipment to create at the same time."
          },
          "identifiers": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "name": {
            "type": "string",
            "description": "The descriptive name or otherwise human-readable description of the shipment created; this is not visible to the carrier."
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "routeInfo": {
            "$ref": "#/components/schemas/RouteInfo"
          }
        },
        "description": "The overall shipper's construct of the material good(s) to be transported by the carrier."
      },
      "CreateUpdateAirShippingDetails": {
        "properties": {
          "accessorials": {
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "type": "array",
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirCargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo."
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirIncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "items": {
              "$ref": "#/components/schemas/BookingParty"
            },
            "type": "array",
            "minItems": 1,
            "description": "Individual shipper-represented groups which are involved with the shipment on this"
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or inland locations."
          }
        },
        "type": "object",
        "required": []
      },
      "CreateUpdateBooking": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "A shipper-provided list of custom key-value list pairs relevant to the booking which are shared with the carrier."
          },
          "apiConfiguration": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ApiConfiguration"
              }
            ],
            "description": "Field for configuring the behavior of this API."
          },
          "capacityProviderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
              }
            ],
            "description": "Reference to the desired carrier to transport the shipment across the booking's specified route segments."
          },
          "carrierContacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingContact"
            },
            "description": "Individuals representing the carrier to whom the booking should be sent. These contacts are not notify parties nor any individuals working with or on behalf of the shipper."
          },
          "expirationDateTime": {
            "type": "string",
            "description": "The datetime of expiration for this request from the shipper to the carrier. A timezone offset is required.",
            "format": "date-time"
          },
          "fuelSurchargeRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the fuel surcharge component of the bookings rate itemized separately from total rate."
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "rateIdentifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RateIdentifier"
            },
            "description": "A list of at least one identifier as reference to the original source of the rate applicable to the booking. Typically a spot quote or a contract ID."
          },
          "routeSegmentIds": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "description": "List of route-segment ids which apply to the booking."
          },
          "shipmentId": {
            "type": "string",
            "description": "The project44-generated identifier for the shipment which parents the booking. Optional when created with a Shipment in one request. Required when creating a booking separately.",
            "format": "uuid"
          },
          "shipmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentDetails"
            },
            "description": "Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body."
          },
          "shipperContactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Contact method to reach the shipper making the booking request."
          },
          "shippingDetails": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CreateUpdateTruckloadShippingDetails"
              },
              {
                "$ref": "#/components/schemas/CreateUpdateOceanShippingDetails"
              },
              {
                "$ref": "#/components/schemas/CreateUpdateAirShippingDetails"
              }
            ],
            "description": "Information about how a load should be handled in transportation, specific to mode."
          },
          "totalRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the rate for transporting the load to the stops specified in the booking."
          }
        },
        "description": "As a shipper, request a booking from a carrier to transport a load across 1+ route segments."
      },
      "CreateUpdateBookingWithId": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "A shipper-provided list of custom key-value list pairs relevant to the booking which are shared with the carrier."
          },
          "apiConfiguration": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ApiConfiguration"
              }
            ],
            "description": "Field for configuring the behavior of this API."
          },
          "capacityProviderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
              }
            ],
            "description": "Reference to the desired carrier to transport the shipment across the booking's specified route segments."
          },
          "carrierContacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingContact"
            },
            "description": "Individuals representing the carrier to whom the booking should be sent. These contacts are not notify parties nor any individuals working with or on behalf of the shipper."
          },
          "expirationDateTime": {
            "type": "string",
            "description": "The datetime of expiration for this request from the shipper to the carrier. A timezone offset is required.",
            "format": "date-time"
          },
          "fuelSurchargeRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the fuel surcharge component of the bookings rate itemized separately from total rate."
          },
          "id": {
            "type": "string",
            "description": "The project44-generated identifier for the booking.",
            "format": "uuid"
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "rateIdentifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RateIdentifier"
            },
            "description": "A list of at least one identifier as reference to the original source of the rate applicable to the booking. Typically a spot quote or a contract ID."
          },
          "routeSegmentIds": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "description": "List of route-segment ids which apply to the booking."
          },
          "shipmentId": {
            "type": "string",
            "description": "The project44-generated identifier for the shipment which parents the booking. Optional when created with a Shipment in one request. Required when creating a booking separately.",
            "format": "uuid"
          },
          "shipmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentDetails"
            },
            "description": "Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body."
          },
          "shipperContactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Contact method to reach the shipper making the booking request."
          },
          "shippingDetails": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CreateUpdateTruckloadShippingDetails"
              },
              {
                "$ref": "#/components/schemas/CreateUpdateOceanShippingDetails"
              },
              {
                "$ref": "#/components/schemas/CreateUpdateAirShippingDetails"
              }
            ],
            "description": "Information about how a load should be handled in transportation, specific to mode."
          },
          "totalRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Optionally include the rate for transporting the load to the stops specified in the booking."
          }
        },
        "description": "As a shipper, request a booking from a carrier to transport a load across 1+ route segments."
      },
      "CreateUpdateDocument": {
        "required": [],
        "type": "object",
        "properties": {
          "identifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Identifier"
            },
            "description": "The list of identifiers related to this document. When x-tenant-role is 'CARRIER' InternalEntityType.SHIPPER_TENANT_UUID is MANDATORY if you want to associate this Document to Shipment. InternalEntityType.SHIPPER_TENANT_UUID is number identifying Shipper in project44."
          },
          "mode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentMode"
              }
            ],
            "description": "The mode of transportation for this document."
          },
          "name": {
            "type": "string",
            "description": "The name of this document."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentType"
              }
            ],
            "description": "The type of this document."
          }
        }
      },
      "CreateUpdateOceanShippingDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "bookingType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanBookingType"
              }
            ],
            "description": "The type of sea freight to be handled; the container-fill volume, or lack thereof."
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo. \nRequired when booking `ROLL_ON_ROLL_OFF` and `LESS_THAN_CONTAINER_LOAD`."
          },
          "containerCount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FullContainerLoadContainerCount"
              },
              {
                "$ref": "#/components/schemas/OutOfGaugeContainerCount"
              }
            ],
            "description": "Number of equipment requested for a booking needs to be provided here. Only required when booking `FULL_CONTAINER_LOAD` or `OUT_OF_GAUGE`."
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingParty"
            },
            "description": "Individual shipper-represented groups which are involved with the shipment on this"
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or boat-inaccessible yards."
          }
        }
      },
      "CreateUpdatePackage": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageAccessorial"
            },
            "default": [],
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable to your package which may be noteworthy to the carrier."
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageItem"
            },
            "minItems": 1,
            "description": "List of items in the package with order associations."
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "minItems": 1,
            "description": "The identifiers that can identify this package (e.g., DELIVERY_NUMBER, OLPN)."
          },
          "isStackable": {
            "type": "boolean",
            "default": false,
            "description": "Flag indicating whether this package is stackable."
          },
          "package": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackageDetails"
              }
            ],
            "description": "Physical details of the package."
          }
        },
        "description": "Package information for booking requests. Contains items, package details, identifiers, and stackability."
      },
      "CreateUpdateTruckloadShippingDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "flatbedType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FlatbedType"
              }
            ],
            "description": "The sub-equipment type of flatbed. Only applicable, and required, with a FLATBED trailer type."
          },
          "loadPreference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TruckLoadPreferenceType"
              }
            ],
            "description": "The preferred load occupancy of the truck."
          },
          "trailerType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TrailerType"
              }
            ],
            "description": "The equipment type of the trailer."
          },
          "trailerDetails": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FlatbedType"
              },
              {
                "$ref": "#/components/schemas/multi_modal_booking_service_public__shipping_details__truckload__ContainerType"
              },
              {
                "$ref": "#/components/schemas/MegaType"
              },
              {
                "$ref": "#/components/schemas/RefrigeratedTrailerDetails"
              }
            ],
            "description": "Optional details if requested trailer is of FLATBED, MEGA, CONTAINER or REFRIGERATED type."
          },
          "trailerLength": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Length"
              }
            ],
            "description": "Total requested trailer length in feet or meters; must not exceed 53 Feet or 17 meters."
          },
          "trailerVolume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "Total requested Trailer volume"
          }
        }
      },
      "Crs": {
        "properties": {
          "properties": {
            "properties": {},
            "type": "object"
          },
          "type": {
            "enum": [
              "name",
              "link"
            ],
            "type": "string"
          }
        },
        "title": "Crs",
        "type": "object"
      },
      "CubicDimension": {
        "description": "A cubic dimension.",
        "properties": {
          "height": {
            "description": "Height measurement.",
            "type": "number"
          },
          "length": {
            "description": "Length measurement.",
            "type": "number"
          },
          "width": {
            "description": "Width measurement.",
            "type": "number"
          }
        },
        "title": "CubicDimension",
        "type": "object"
      },
      "Currency": {
        "type": "string",
        "description": "The currency of the shipment value",
        "format": "enum",
        "enum": [
          "USD",
          "CAD",
          "MXN",
          "EUR"
        ]
      },
      "CurrencyConversionAuditInfo": {
        "description": "Currency conversion metadata.",
        "properties": {
          "conversionRate": {
            "description": "The currency conversion rate applied.",
            "type": "number"
          },
          "conversionTimestamp": {
            "description": "The timestamp of the currency conversion.",
            "type": "string"
          }
        },
        "title": "CurrencyConversionAuditInfo",
        "type": "object"
      },
      "CustomAttribute": {
        "required": [],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string",
            "description": "The key (name) for the custom attribute. Must be unique."
          },
          "value": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string",
            "deprecated": true
          },
          "values": {
            "maxItems": 250,
            "minItems": 1,
            "type": "array",
            "description": "The values for the custom attribute.",
            "items": {
              "maxLength": 255,
              "minLength": 1,
              "type": "string",
              "description": "The values for the custom attribute."
            }
          }
        },
        "description": "An optional user-defined set of custom attributes to associate with this shipment."
      },
      "CustomerAccount": {
        "properties": {
          "accountIdentifier": {
            "description": "The account identifier of the customer to whom this shipment belongs. This will be used to identify the mutual customer in project44's system.",
            "type": "string"
          }
        },
        "title": "CustomerAccount",
        "type": "object"
      },
      "CustomsBroker": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "description": "Primary Address line for the customsBroker location."
          },
          "address2": {
            "type": "string",
            "description": "Secondary Address line for the customsBroker location."
          },
          "city": {
            "type": "string",
            "description": "City Name for the customsBroker location."
          },
          "country": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CountryCode"
              }
            ],
            "description": "Three letter country code for the customsBroker location."
          },
          "contact": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLContact"
              }
            ],
            "description": "Contact related to the customs broker."
          },
          "name": {
            "type": "string",
            "description": "Company name associated with the customsBroker location."
          },
          "postalCode": {
            "maxLength": 6,
            "minLength": 5,
            "type": "string",
            "description": "The 5-digit (or 6-characters for Canada) zip code for the customsBroker location."
          },
          "stateProvince": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StateProvinceCode"
              }
            ],
            "description": "Two letter state/province code for the customsBroker location."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomsBrokerType"
              }
            ],
            "description": "Used to identify a customs broker that is involved in a cross-border freight move.Valid Values: Import or Export.Import: customs broker handling the destination-side of the cross-border freight move.Export: customs broker handling the origin-side of the cross-border freight move."
          }
        }
      },
      "CustomsBrokerType": {
        "enum": [
          "Import",
          "Export"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "CustomsInfo": {
        "description": "A customs broker information.",
        "properties": {
          "customsBrokerLocation": {
            "$ref": "#/components/schemas/Location"
          }
        },
        "title": "CustomsInfo",
        "type": "object"
      },
      "CutOffDetails": {
        "type": "object",
        "properties": {
          "cutOffDatetime": {
            "type": "string",
            "description": "The last date and time on which it is possible to make changes",
            "format": "date-time"
          },
          "documentationCutOffDatetime": {
            "type": "string",
            "description": "The last date and time when the documentation should be sent to the carrier",
            "format": "date-time"
          },
          "vesselCutOffDatetime": {
            "type": "string",
            "description": "The last date and time when the container should arrive to the port",
            "format": "date-time"
          }
        }
      },
      "DataOriginator": {
        "type": "object",
        "properties": {
          "tenantUuid": {
            "type": "string",
            "description": "UUID of the tenant.",
            "format": "uuid"
          },
          "tenantName": {
            "type": "string",
            "description": "Name of the tenant."
          },
          "tenantId": {
            "type": "integer",
            "description": "Legacy identifier of the tenant, not to be used externally.",
            "format": "int64"
          },
          "tenantRegion": {
            "type": "string",
            "description": "Source region of the tenant.",
            "enum": [
              "NA12",
              "EU12"
            ]
          }
        },
        "description": "Tenant that created the shared data."
      },
      "DataRecipient": {
        "type": "object",
        "properties": {
          "tenantUuid": {
            "type": "string",
            "description": "UUID of the tenant.",
            "format": "uuid"
          },
          "tenantName": {
            "type": "string",
            "description": "Name of the tenant."
          },
          "tenantId": {
            "type": "integer",
            "description": "Legacy identifier of the tenant, not to be used externally.",
            "format": "int64"
          },
          "tenantRegion": {
            "type": "string",
            "description": "Recipient tenant's Source region.",
            "enum": [
              "NA12",
              "EU12"
            ]
          }
        },
        "description": "Tenant to whom the data is shared."
      },
      "DateQuartiles": {
        "properties": {
          "date": {
            "description": "The first date in this timespan, in ISO-8601 format",
            "type": "string"
          },
          "p25": {
            "description": "The 25th percentile value of this metric in days.",
            "format": "double",
            "type": "number"
          },
          "p50": {
            "description": "The median value of this metric in days.",
            "format": "double",
            "type": "number"
          },
          "p75": {
            "description": "The 75th percentile value of this metric in days.",
            "format": "double",
            "type": "number"
          }
        },
        "title": "DateQuartiles",
        "type": "object"
      },
      "DateWindow": {
        "required": [],
        "type": "object",
        "properties": {
          "end": {
            "type": "string",
            "description": "The end date (with or without time)  of the requested delivery window.Required when the timeCriticalDetails.type is Delivery Window.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          },
          "start": {
            "type": "string",
            "description": "The date (with or without time) the shipment is requested to be delivered.Required when timeCriticalDetails.type is populated with any valid value.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          }
        }
      },
      "DeckHeight": {
        "enum": [
          "STANDARD",
          "DROP_DECK",
          "DOUBLE_DROP"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "DeckHeightAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "DECK_HEIGHT"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_DeckHeight_"
              }
            ],
            "description": "Deck height Specification."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which defined the expected height of the deck on the vehicle."
      },
      "DeliveryAccessorials": {
        "enum": [
          "NCDEL",
          "LTDDEL",
          "AIRDEL",
          "CAMPDEL",
          "CHRCDEL",
          "CLUBDEL",
          "CNVDEL",
          "CONDEL",
          "EDUDEL",
          "FARMDEL",
          "GOVDEL",
          "GRODEL",
          "HOSDEL",
          "HOTLDEL",
          "MILDEL",
          "MINEDEL",
          "NARDEL",
          "NURSDEL",
          "PARKDEL",
          "PIERDEL",
          "PRISDEL",
          "SSTORDEL",
          "UTLDEL",
          "NBDEL",
          "AFTRHRDEL",
          "HDAYDEL",
          "WEDEL",
          "SATDEL",
          "SUNDEL",
          "APPTDEL",
          "NOTIFY",
          "INDEL",
          "INEDEL",
          "INGDEL",
          "INNEDEL",
          "UNLOADDEL",
          "COMDEL",
          "DCDEL",
          "CFSDEL",
          "DOCKDEL",
          "DVALDEL",
          "EMERGENCYDEL",
          "FBEDDEL",
          "LGDEL",
          "MALLDEL",
          "OVSZEDEL",
          "PJACKDEL",
          "RESDEL",
          "RSRTDEL",
          "SORTDEL",
          "TWOMAN",
          "XCHGDEL",
          "XFERDEL",
          "CSNLDDEL"
        ],
        "description": "An enumeration."
      },
      "DeliveryAppointmentDetails": {
        "type": "object",
        "properties": {
          "end": {
            "type": "string",
            "description": "Ending appointment date (with or without time) the shipment is requested to be delivered.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          },
          "start": {
            "type": "string",
            "description": "Starting appointment date (with or without time) the shipment is requested to be delivered.Required when accessorials.code list includes APTD.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          }
        }
      },
      "DerivedOrderHealth": {
        "description": "derived order health.",
        "properties": {
          "arrivalStatus": {
            "$ref": "#/components/schemas/ArrivalStatus"
          },
          "estimatedTimeOfArrival": {
            "description": "Estimated delivery date and time for this order based on its constituent shipments (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2022-11-14T12:30:00-0500).  This field is generated by project44.",
            "type": "string"
          }
        },
        "title": "DerivedOrderHealth",
        "type": "object"
      },
      "DescribeShipmentResponse": {
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "accessGroups": {
            "uniqueItems": true,
            "type": "array",
            "description": "This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/AccessGroup"
            }
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.",
            "format": "date-time"
          },
          "costs": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "All costs incurred for this shipment and the assets contained within.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentCost"
            }
          },
          "contents": {
            "type": "array",
            "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentContent"
            }
          },
          "events": {
            "type": "array",
            "description": "All events that occurred for this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentEvent"
            }
          },
          "id": {
            "type": "string",
            "description": "Master shipment id of the shipment. Will always be populated on the response.",
            "format": "uuid"
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Used to identify a shipment.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.",
            "format": "date-time"
          },
          "plan": {
            "$ref": "#/components/schemas/ShipmentPlan"
          },
          "problems": {
            "type": "array",
            "description": "List of errors and/or warnings that occurred while processing the request",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/Message"
            }
          },
          "routeInfo": {
            "$ref": "#/components/schemas/ShipmentRouteInfo"
          },
          "relatedShipments": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "List of related shipments of the parent shipment. This is optional.",
            "xml": {
              "name": "sub_shipments",
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/SimpleTrackedShipment"
            }
          },
          "shipmentShareLink": {
            "type": "string",
            "description": "Public link to view the shipment in the VOC."
          }
        },
        "description": "Response model for the describe shipment API"
      },
      "DimensionalWeight": {
        "description": "The Dimensional Weight which includes quantity, package type, cubic dimension details, and weight details for the inventory item",
        "properties": {
          "cubicDimension": {
            "$ref": "#/components/schemas/CubicDimension"
          },
          "lengthUnit": {
            "description": "The length unit applicable for the cubic dimension details for the DimensionalWeight",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "packageType": {
            "description": "The package type for the DimensionalWeight",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PAIL",
              "PLT",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TUBE",
              "EACH",
              "FLAT",
              "LOOSE"
            ],
            "type": "string"
          },
          "quantity": {
            "description": "The quantity of identical packages that make up this inventory item",
            "format": "int64",
            "type": "integer"
          },
          "weight": {
            "$ref": "#/components/schemas/Weight"
          }
        },
        "title": "DimensionalWeight",
        "type": "object"
      },
      "Dimensions": {
        "type": "object",
        "properties": {
          "height": {
            "minimum": 0,
            "type": "number"
          },
          "length": {
            "minimum": 0,
            "type": "number"
          },
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LengthUnit"
              }
            ],
            "description": "The unit of measurement for these lengths. Defaults to FT.",
            "default": "FT"
          },
          "width": {
            "minimum": 0,
            "type": "number"
          }
        }
      },
      "DimensionsUnit": {
        "enum": [
          "Inches",
          "Centimeters"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "DistanceMeasurement": {
        "type": "object",
        "properties": {
          "unit": {
            "$ref": "#/components/schemas/DistanceUnit"
          },
          "value": {
            "type": "number",
            "description": "Numeric value of a measurement"
          }
        },
        "description": "A measure of distance with a value and unit"
      },
      "DistanceUnit": {
        "type": "string",
        "description": "Physical unit of measurement",
        "format": "enum",
        "enum": [
          "FT",
          "M",
          "MI",
          "KM"
        ]
      },
      "DockRequiredAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "DOCK_REQUIRED"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for dock service."
      },
      "Document": {
        "required": [],
        "type": "object",
        "properties": {
          "addedByCompany": {
            "type": "string",
            "description": "The company name of the tenant owning this document."
          },
          "addedByUser": {
            "type": "string",
            "description": "The name of the user owning this document."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this document was created. This value is read only.",
            "format": "date-time"
          },
          "deletedDateTime": {
            "type": "string",
            "description": "The date and time when this document was deleted. This value is read only.",
            "format": "date-time"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Image"
            },
            "description": "The list of images related to this document."
          },
          "identifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Identifier"
            },
            "description": "The list of identifiers related to this document. When x-tenant-role is 'CARRIER' InternalEntityType.SHIPPER_TENANT_UUID is MANDATORY if you want to associate this Document to Shipment. InternalEntityType.SHIPPER_TENANT_UUID is number identifying Shipper in project44."
          },
          "id": {
            "type": "string",
            "description": "The id of this document. Will always be populated on response.",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this document was last modified. This value is read only.",
            "format": "date-time"
          },
          "mode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentMode"
              }
            ],
            "description": "The mode of transportation for this document."
          },
          "name": {
            "type": "string",
            "description": "The name of this document."
          },
          "parsedData": {
            "type": "object",
            "description": "Parsed data extracted from the document. The structure varies based on document type and content.",
            "additionalProperties": true
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentType"
              }
            ],
            "description": "The type of this document."
          }
        }
      },
      "DocumentEventDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "documentType": {
            "type": "string",
            "description": "Type of document",
            "enum": [
              "UNKNOWN",
              "BILL_OF_LADING",
              "HOUSE_BILL_OF_LADING",
              "AIRWAY_BILL",
              "COMMERCIAL_INVOICE",
              "CUSTOMS_DOCUMENTS",
              "PACKING_SLIP",
              "PACK_SLIP",
              "CERTIFICATE_OF_ORIGIN",
              "PROOF_OF_DELIVERY",
              "DELIVERY_RECEIPT",
              "ECMR",
              "WEIGHT_CERTIFICATE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "INVOICE",
              "HAZMAT_DOCUMENT",
              "SHIPPING_LABEL",
              "OTHER",
              "MISCELLANEOUS"
            ]
          },
          "fileFormat": {
            "type": "string",
            "description": "Format of the document file",
            "enum": [
              "UNKNOWN",
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPEG"
            ]
          },
          "scope": {
            "type": "string",
            "description": "Scope of the document",
            "enum": [
              "UNKNOWN",
              "SHIPPER",
              "CARRIER",
              "DRIVER"
            ]
          },
          "url": {
            "type": "string",
            "description": "URL to access the document"
          },
          "version": {
            "type": "integer",
            "description": "Version number of the document",
            "format": "int32"
          }
        },
        "description": "Details of an event related to document handling"
      },
      "DocumentMode": {
        "enum": [
          "AIR",
          "OCEAN",
          "TL",
          "LTL",
          "PARCEL",
          "RAIL",
          "BARGE"
        ],
        "type": "string",
        "description": "The mode of transportation for a document."
      },
      "DocumentType": {
        "enum": [
          "BILL_OF_LADING",
          "HOUSE_BILL_OF_LADING",
          "AIRWAY_BILL",
          "COMMERCIAL_INVOICE",
          "CUSTOMS_DOCUMENTS",
          "PACKING_SLIP",
          "CERTIFICATE_OF_ORIGIN",
          "PROOF_OF_DELIVERY",
          "DELIVERY_RECEIPT",
          "ECMR",
          "WEIGHT_CERTIFICATE",
          "INSPECTION_CERTIFICATE",
          "LETTER_OF_AUTHORIZATION",
          "LUMPER_CERTIFICATE",
          "INVOICE",
          "HAZMAT_DOCUMENT",
          "SHIPPING_LABEL",
          "OTHER"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "DryCargoContainerCount": {
        "type": "object",
        "properties": {
          "fortyFootContainerCount": {
            "type": "integer",
            "description": "Count of 40ft flat-rack containers",
            "default": 0
          },
          "fortyFootHighCubeCount": {
            "type": "integer",
            "description": "Count of 40ft flat-rack high-cube containers",
            "default": 0
          },
          "fortyfiveFootHighCubeCount": {
            "type": "integer",
            "description": "Count of 45ft flat-rack high-cube containers",
            "default": 0
          },
          "fortyFootOpenTopCount": {
            "type": "integer",
            "description": "Count of 40ft open-top containers",
            "default": 0
          },
          "twentyFootContainerCount": {
            "type": "integer",
            "description": "Count of 20ft flat-rack containers",
            "default": 0
          }
        }
      },
      "Ebol": {
        "required": [],
        "type": "object",
        "properties": {
          "images": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EbolImages"
              }
            ],
            "description": "Images related to the eBOL request such as BOL or Shipping Labels."
          },
          "messageStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EbolMessageStatus"
              }
            ],
            "description": "Object containing message status details."
          },
          "referenceNumbers": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EbolReferenceNumbers"
              }
            ],
            "description": "Reference numbers related to the eBOL request."
          },
          "transactionDate": {
            "type": "string",
            "description": "The date associated with this electronic bill of lading transaction.",
            "format": "date-time"
          },
          "version": {
            "type": "string",
            "description": "Indicates which version of the Digital LTL Council Bill of Lading spec was returned. Example: v1"
          }
        }
      },
      "EbolImages": {
        "required": [],
        "type": "object",
        "properties": {
          "bol": {
            "type": "string",
            "description": "Base 64 encoded PDF of the populated Bill Of Lading."
          },
          "shippingLabels": {
            "type": "string",
            "description": "Base 64 encoded PDF of the populated shipping labels."
          }
        }
      },
      "EbolMessageStatus": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Indicates response detail code."
          },
          "information": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MessageStatusInformation"
            },
            "description": "List of information related to the eBOL request."
          },
          "message": {
            "type": "string",
            "description": "Provides information pertaining to the response code."
          },
          "resolution": {
            "type": "string",
            "description": "Provides guidance pertaining to the response code."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessageStatus"
              }
            ],
            "description": "Indicates the status of the request."
          }
        }
      },
      "EbolReferenceNumbers": {
        "required": [],
        "type": "object",
        "properties": {
          "pro": {
            "type": "string",
            "description": "Shipper's pre-assigned PRO number for the requested carrier. If one was not provided in the request, one will be auto assigned by the carrier."
          },
          "shipmentConfirmationNumber": {
            "type": "string",
            "description": "Number provided by the carrier to acknowledge they accepted the BOL."
          }
        }
      },
      "Email": {
        "required": [],
        "type": "object",
        "properties": {
          "addresses": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Provide one or more email addresses to receive the bol and/or shipping labels PDF."
          },
          "includeBol": {
            "type": "boolean",
            "description": "Used to request the bill of lading PDF to be sent to one or more email addresses."
          },
          "includeLabels": {
            "type": "boolean",
            "description": "Used to request the shipping labels PDF to be sent to one or more email addresses."
          }
        }
      },
      "EmergencyContact": {
        "required": [],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Full name of who should be contacted in the case of a hazardous materials-related issue."
          },
          "phone": {
            "maxLength": 10,
            "minLength": 10,
            "type": "string",
            "description": "Phone number of who should be contacted in the case of a hazardous materials-related issue.Valid Formats: ########## (10 digits - Area code + phone)."
          }
        }
      },
      "EmissionData": {
        "description": "Describes emission data.",
        "properties": {
          "cargoWeight": {
            "$ref": "#/components/schemas/WeightMeasurement"
          },
          "co2EmissionIntensity": {
            "$ref": "#/components/schemas/WeightPerDistanceMeasurement"
          },
          "distance": {
            "$ref": "#/components/schemas/DistanceMeasurement"
          },
          "loadFactor": {
            "description": "Ratio of weight or volume of cargo in the shipment to the vehicle's capacity.",
            "format": "float",
            "type": "number"
          },
          "totalCO2Emissions": {
            "$ref": "#/components/schemas/WeightMeasurement"
          },
          "vehicleInfo": {
            "$ref": "#/components/schemas/VehicleInfo"
          }
        },
        "title": "EmissionData",
        "type": "object"
      },
      "EquipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The equipment type of the tracked asset.",
            "enum": [
              "CONTAINER_ID",
              "RAIL_CAR_ID",
              "TRAILER_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The equipment initials and number of the tracked asset, e.g., BNSF654321.",
            "type": "string"
          }
        },
        "title": "EquipmentIdentifier",
        "type": "object"
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "example": "BAD_REQUEST"
          },
          "details": {
            "type": "string",
            "description": "Additional error details",
            "example": "slotEndDateTime must be later than slotStartDateTime"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "Invalid request data"
          },
          "severity": {
            "type": "string",
            "enum": [
              "ERROR",
              "WARNING",
              "INFO"
            ],
            "description": "Severity level of the error",
            "example": "ERROR"
          },
          "traceId": {
            "type": "string",
            "description": "Trace ID for debugging",
            "example": "abc123def456"
          }
        }
      },
      "ExceptionDetail": {
        "type": "object",
        "properties": {
          "airFlightDetails": {
            "$ref": "#/components/schemas/AirFlightDetails"
          },
          "oceanBookingUpdateDetails": {
            "$ref": "#/components/schemas/OceanBookingUpdateDetails"
          },
          "temperatureSensorDetails": {
            "$ref": "#/components/schemas/TemperatureSensorDetails"
          }
        },
        "description": "Detail of the exception"
      },
      "ExcessiveLength": {
        "required": [],
        "type": "object",
        "properties": {
          "length": {
            "maximum": 30,
            "minimum": 6,
            "type": "integer",
            "description": "Excessive Length requested in feet."
          }
        },
        "additionalProperties": false
      },
      "ExcessiveLengthAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "EXCESSIVE_LENGTH"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_ExcessiveLength_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for appointment service."
      },
      "ExcessLengthAccessorials": {
        "enum": [
          "ELS_6",
          "ELS_7",
          "ELS_8",
          "ELS_9",
          "ELS_10",
          "ELS_11",
          "ELS_12",
          "ELS_13",
          "ELS_14",
          "ELS_15",
          "ELS_16",
          "ELS_17",
          "ELS_18",
          "ELS_19",
          "ELS_20",
          "ELS_21",
          "ELS_22",
          "ELS_23",
          "ELS_24",
          "ELS_25",
          "ELS_26",
          "ELS_27",
          "ELS_28",
          "ELS_29",
          "ELS_30"
        ],
        "description": "An enumeration."
      },
      "Exclusion": {
        "type": "object",
        "description": "${Exclusion.apiModel.class.value}"
      },
      "FileType": {
        "enum": [
          "PDF",
          "PNG",
          "JPEG",
          "GIF",
          "TIF"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "FilterSuggestionRequest": {
        "required": [],
        "type": "object",
        "properties": {
          "fieldType": {
            "type": "string",
            "description": "The target field for which to retrieve suggestions.",
            "enum": [
              "ATTRIBUTE_KEY",
              "ATTRIBUTE_VALUE",
              "CARRIER_NAME",
              "CARRIER_IATA",
              "CARRIER_ICAO",
              "CARRIER_SCAC",
              "CARRIER_US_DOT_NUMBER",
              "CARRIER_MC_NUMBER",
              "CARRIER_NMC_ID",
              "CARRIER_MASTER_ID",
              "VESSEL_NAME",
              "VESSEL_MMSI",
              "VESSEL_IMO",
              "VESSEL_CALL_SIGN",
              "TRAILER_ID",
              "VEHICLE_ID",
              "LICENSE_PLATE",
              "RAIL_CAR_ID",
              "FLIGHT_NUMBER",
              "DRIVER_MOBILE_PHONE_NUMBER",
              "WAGON_ID",
              "TRAIN_NUMBER",
              "EXPORT_CUSTOMS_BROKER",
              "IMPORT_CUSTOMS_BROKER",
              "POL_QUALITY_CONTROL_PROVIDER",
              "POD_QUALITY_CONTROL_PROVIDER",
              "ORIGIN_LOCATION_NAME",
              "ORIGIN_ADDRESS",
              "ORIGIN_CITY",
              "ORIGIN_STATE",
              "ORIGIN_COUNTRY",
              "ORIGIN_ZIP",
              "ORIGIN_PORT_CODE",
              "ORIGIN_AIRPORT_CODE",
              "DESTINATION_LOCATION_NAME",
              "DESTINATION_ADDRESS",
              "DESTINATION_CITY",
              "DESTINATION_STATE",
              "DESTINATION_COUNTRY",
              "DESTINATION_ZIP",
              "DESTINATION_PORT_CODE",
              "DESTINATION_AIRPORT_CODE",
              "STOP_LOCATION_NAME",
              "STOP_ADDRESS",
              "STOP_CITY",
              "STOP_STATE",
              "STOP_COUNTRY",
              "STOP_ZIP",
              "STOP_PORT_CODE",
              "STOP_AIRPORT_CODE",
              "EVENT_DESCRIPTION",
              "EVENT_LOCATION_NAME",
              "EVENT_ADDRESS",
              "EVENT_CITY",
              "EVENT_STATE",
              "EVENT_COUNTRY",
              "EVENT_ZIP",
              "EVENT_PORT_CODE",
              "EVENT_AIRPORT_CODE",
              "ORDER_IDENTIFIER_CONTRACT",
              "ORDER_IDENTIFIER_LAUNCH_CODE",
              "ORDER_IDENTIFIER_LOAD",
              "ORDER_IDENTIFIER_MANUFACTURER",
              "ORDER_IDENTIFIER_PROMOTION",
              "ORDER_IDENTIFIER_SEASON",
              "ORDER_IDENTIFIER_VENDOR",
              "ORDER_IDENTIFIER_CUSTOMER_ORDER",
              "ORDER_ATTRIBUTE_KEY",
              "ORDER_ATTRIBUTE_VALUE",
              "ORDER_TAG_ANALYST",
              "ORDER_TAG_CARRIER",
              "ORDER_TAG_CATEGORY",
              "ORDER_TAG_COMMODITY",
              "ORDER_TAG_DEPARTMENT",
              "ORDER_TAG_DIRECTOR",
              "ORDER_TAG_FAMILY",
              "ORDER_TAG_GROUP",
              "ORDER_TAG_MANAGER",
              "ORDER_TAG_SECTOR",
              "ORDER_TAG_BATCH",
              "ORDER_ORIGIN_LOCATION_ID",
              "ORDER_ORIGIN_LOCATION_NAME",
              "ORDER_ORIGIN_CITY",
              "ORDER_ORIGIN_STATE",
              "ORDER_ORIGIN_COUNTRY",
              "ORDER_ORIGIN_POSTAL_CODE",
              "ORDER_DESTINATION_LOCATION_ID",
              "ORDER_DESTINATION_LOCATION_NAME",
              "ORDER_DESTINATION_CITY",
              "ORDER_DESTINATION_STATE",
              "ORDER_DESTINATION_COUNTRY",
              "ORDER_DESTINATION_POSTAL_CODE",
              "ORDER_SUPPLIER_LOCATION_ID",
              "ORDER_SUPPLIER_LOCATION_NAME",
              "ORDER_SUPPLIER_CITY",
              "ORDER_SUPPLIER_STATE",
              "ORDER_SUPPLIER_COUNTRY",
              "ORDER_SUPPLIER_POSTAL_CODE",
              "ORDER_BILLING_LOCATION_ID",
              "ORDER_BILLING_LOCATION_NAME",
              "ORDER_BILLING_CITY",
              "ORDER_BILLING_STATE",
              "ORDER_BILLING_COUNTRY",
              "ORDER_BILLING_POSTAL_CODE",
              "LOAD_ITEM_DESCRIPTION",
              "SHARING_RECIPIENT_TENANT_NAME",
              "SHARING_ORIGINATOR_TENANT_NAME",
              "SUMMARIZED_CONNECTION_TYPE",
              "CONNECTION_TRANSMISSION_METHOD",
              "CONNECTION_DATA_FORMAT",
              "CONNECTION_SOURCE_TYPE"
            ]
          },
          "fieldName": {
            "type": "string",
            "description": "Optional - intended to further narrow the search scope when dealing with key-value pairs.\n\nFor example, when searching with fieldType = ATTRIBUTE_VALUE, setting this to \"WAREHOUSE\" will return suggestions only for attributes where the key/name is \"WAREHOUSE\"."
          },
          "limit": {
            "maximum": 100,
            "minimum": 1,
            "type": "integer",
            "description": "The maximum number of suggestions to return.",
            "format": "int32"
          },
          "query": {
            "type": "string",
            "description": "The input with which to search."
          }
        }
      },
      "FilterSuggestionResponse": {
        "type": "object",
        "properties": {
          "suggestions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "A collection of suggestions."
      },
      "FirstComeFirstServedAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "FIRST_COME_FIRST_SERVED"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for first come, first served service."
      },
      "FlatbedType": {
        "enum": [
          "CONESTOGA",
          "DOUBLE_DROP"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "FlightInformation": {
        "type": "object",
        "properties": {
          "flightNumber": {
            "type": "string"
          }
        }
      },
      "ForecastableTimeDuration": {
        "type": "object",
        "properties": {
          "actualDuration": {
            "$ref": "#/components/schemas/TimeDuration"
          },
          "estimatedDuration": {
            "$ref": "#/components/schemas/TimeDuration"
          }
        },
        "description": "A duration of time which may be measured and/or forecasted."
      },
      "FreightClass": {
        "enum": [
          "50",
          "55",
          "60",
          "65",
          "70",
          "77.5",
          "85",
          "92.5",
          "100",
          "110",
          "125",
          "150",
          "175",
          "200",
          "250",
          "300",
          "400",
          "500"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "FreightTerms": {
        "description": "Details the terms of the freight ownership during transport.  Specified in the quote, contract or general terms and conditions.",
        "properties": {
          "freightOwnershipType": {
            "description": "Defines if the carrier collects the transportation charges from the buyer, or the seller prepays for the transportation charges.",
            "enum": [
              "PREPAID",
              "COLLECT"
            ],
            "type": "string"
          },
          "transportationPaymentType": {
            "description": "Defines who pays the freight costs.",
            "enum": [
              "ORIGIN",
              "DESTINATION"
            ],
            "type": "string"
          }
        },
        "title": "FreightTerms",
        "type": "object"
      },
      "FullContainerLoadContainerCount": {
        "type": "object",
        "properties": {
          "dryCargoCount": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DryCargoContainerCount"
              }
            ],
            "description": "Number of dry cargo container units."
          },
          "reeferCount": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReeferContainerCount"
              }
            ],
            "description": "Number of refrigerated container units."
          }
        },
        "description": "Number of containers that has been fully occupied by single consignee. At least one field must be provided."
      },
      "FullValueCoverageDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              }
            ],
            "description": "Optional attribute to indicate currency of monetaryValue. Defaults to USD.",
            "default": "USD"
          },
          "monetaryValue": {
            "type": "string",
            "description": "Value of the cargo. Valid Formats: ##.## (2 decimal places only)."
          }
        }
      },
      "GeoCoordinates": {
        "properties": {
          "latitude": {
            "description": "The approximate geographic latitude of a location, using the WGS84 coordinate system.",
            "format": "float",
            "type": "number"
          },
          "longitude": {
            "description": "The approximate geographic longitude of a location, using the WGS84 coordinate system.",
            "format": "float",
            "type": "number"
          }
        },
        "title": "GeoCoordinates",
        "type": "object"
      },
      "Geofence": {
        "properties": {
          "geometry": {
            "$ref": "#/components/schemas/GeoJsonObject"
          },
          "type": {
            "description": "Geofence type. See reference documentation.",
            "enum": [
              "TIME",
              "DISTANCE",
              "POLYGON"
            ],
            "type": "string"
          },
          "units": {
            "description": "Units the value is provided in. Units must be appropriate for the type.",
            "enum": [
              "MINUTES",
              "METERS"
            ],
            "type": "string"
          },
          "value": {
            "description": "Value in the appropriate units. Only used for TIME and DISTANCE type geofences.",
            "format": "double",
            "type": "number"
          }
        },
        "required": [],
        "title": "Geofence",
        "type": "object"
      },
      "GeoJsonObject": {
        "discriminator": {
          "propertyName": "type"
        },
        "properties": {
          "bbox": {
            "items": {
              "format": "double",
              "type": "number"
            },
            "type": "array"
          },
          "crs": {
            "$ref": "#/components/schemas/Crs"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [],
        "title": "GeoJsonObject",
        "type": "object"
      },
      "GuaranteedByHour": {
        "required": [],
        "type": "object",
        "properties": {
          "hour": {
            "maximum": 14,
            "minimum": 8,
            "type": "integer",
            "description": "Guaranteed by Hour of the day."
          },
          "minute": {
            "maximum": 59,
            "minimum": 0,
            "type": "integer",
            "description": "Minute of the hour.",
            "default": 0
          }
        },
        "additionalProperties": false
      },
      "GuaranteedServiceLevelAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "GUARANTEED"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_GuaranteedByHour_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for appointment service."
      },
      "HandlingUnit": {
        "description": "An object that represents the physical handling unit, e.g. a pallet associated with a shipment.",
        "properties": {
          "commodityType": {
            "description": "This code dictates the duty rating, as well as alerts you to any import or export restrictions.",
            "type": "string"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "deliveryStopNumber": {
            "description": "A reference to the stop number where this item will be dropped off. For LTL this value should always be 2.",
            "format": "int32",
            "type": "integer"
          },
          "description": {
            "description": "A brief description of the handling unit and its contents.",
            "type": "string"
          },
          "freightClasses": {
            "description": "A list of freight classes for this handling unit.",
            "items": {
              "enum": [
                "50",
                "55",
                "60",
                "65",
                "70",
                "77.5",
                "85",
                "92.5",
                "100",
                "110",
                "125",
                "150",
                "175",
                "200",
                "250",
                "300",
                "400",
                "500"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "handlingUnitDimensions": {
            "$ref": "#/components/schemas/CubicDimension"
          },
          "handlingUnitQuantity": {
            "description": "The number of handling units identical to this one.",
            "format": "int32",
            "type": "integer"
          },
          "handlingUnitType": {
            "description": "The type of the handling unit.",
            "enum": [
              "BAG",
              "BALE",
              "BARREL",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PACK",
              "PAIL",
              "PALLET",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TRAY",
              "TUBE"
            ],
            "type": "string"
          },
          "harmonizedCode": {
            "description": "Harmonized System (HS) Code for the product as defined by the World Customers Organization, usually 6 characters in length, but up to 10 characters as defined by customs organizations by country.In the US, this would be the HTS or HTSA Code as defined by the US International Trade Commission.",
            "type": "string"
          },
          "nmfcCodes": {
            "description": "A list of the NMFC codes associated with this shipment.",
            "items": {
              "$ref": "#/components/schemas/NmfcCode"
            },
            "type": "array"
          },
          "packages": {
            "description": "The packages on/in this handling unit.",
            "items": {
              "$ref": "#/components/schemas/Package"
            },
            "type": "array"
          },
          "pickupStopNumber": {
            "description": "A reference to the stop number where this item will be picked up. For LTL this value should always be 1",
            "format": "int32",
            "type": "integer"
          },
          "stackable": {
            "description": "True false value indicating whether or not the handling units can be stacked",
            "type": "boolean"
          },
          "totalValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "weightPerHandlingUnit": {
            "description": "Weight per handling unit.",
            "type": "number"
          }
        },
        "title": "HandlingUnit",
        "type": "object"
      },
      "HandlingUnitsDetails": {
        "type": "object",
        "properties": {
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingHandlingUnit"
            },
            "description": "A list of details that describe the specifics of the handling units for this load."
          }
        }
      },
      "HandlingUnitType": {
        "enum": [
          "BAG",
          "BALE",
          "BOX",
          "BUCKET",
          "BUNDLE",
          "CAN",
          "CARTON",
          "CASE",
          "COIL",
          "CRATE",
          "CYLINDER",
          "DRUM",
          "PAIL",
          "PALLET",
          "PIECES",
          "REEL",
          "ROLL",
          "SKID",
          "TOTE",
          "TUBE"
        ],
        "type": "string",
        "description": "Enumeration of supported package type codes."
      },
      "HandlingUnitTypeCode": {
        "enum": [
          "BAG",
          "BAL",
          "BBL",
          "BSK",
          "BIN",
          "BOX",
          "BXT",
          "BCH",
          "BDL",
          "CAB",
          "CAG",
          "CAN",
          "CBY",
          "CAR",
          "CTN",
          "CAS",
          "CSK",
          "CHS",
          "COL",
          "CNT",
          "COR",
          "CRT",
          "CYL",
          "DRM",
          "DBK",
          "ENV",
          "FIR",
          "GLD",
          "HPR",
          "HGH",
          "HRB",
          "INT",
          "JAR",
          "JCN",
          "KEG",
          "KIT",
          "LIF",
          "LBK",
          "LSE",
          "MXD",
          "OTH",
          "PKG",
          "PCK",
          "PAL",
          "PAT",
          "PCS",
          "PLN",
          "RCK",
          "REL",
          "ROL",
          "SKD",
          "SLP",
          "SPL",
          "TNK",
          "TBN",
          "TRY",
          "TRU",
          "TRK",
          "TUB",
          "TBE",
          "UNT",
          "VPK",
          "WRP"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "HandlingUnitTypeQuantity": {
        "description": "An object that represents the quantity of each handling unit type.",
        "properties": {
          "handlingUnitType": {
            "description": "The type of handling unit.",
            "enum": [
              "BAG",
              "BALE",
              "BARREL",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PACK",
              "PAIL",
              "PALLET",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TRAY",
              "TUBE"
            ],
            "type": "string"
          },
          "quantity": {
            "description": "The quantity of this particular handling unit type. ",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "HandlingUnitTypeQuantity",
        "type": "object"
      },
      "HazardousDetails": {
        "type": "object",
        "properties": {
          "class": {
            "type": "string",
            "description": "Class that the hazardous material is categorized by."
          },
          "contractNumber": {
            "type": "string",
            "description": "The contract number with the hazardous materials contact."
          },
          "propername": {
            "type": "string",
            "description": "Proper shipping name for the hazardous material. From DOT regulations 172.101"
          },
          "packingGroup": {
            "type": "string",
            "description": "Hazmat Packing Group number. Not all hazmat items have a packing group."
          },
          "technicalName": {
            "type": "string",
            "description": "Technical name for the hazardous material. Not all hazardous items will have a technical name. From DOT regulations 172.101"
          },
          "unnaNumber": {
            "type": "string",
            "description": "Proper Identification Number (UN or NA) corresponding to the Proper Shipping Name."
          },
          "weight": {
            "type": "integer",
            "description": "Total weight of hazardous material covered by one description."
          }
        }
      },
      "HazardousDetailsContact": {
        "required": [],
        "type": "object",
        "properties": {
          "emergencyContact": {
            "$ref": "#/components/schemas/EmergencyContact"
          }
        }
      },
      "HazmatAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "HAZMAT"
            ],
            "type": "string"
          },
          "details": {
            "$ref": "#/components/schemas/HazmatKind"
          }
        },
        "additionalProperties": false,
        "description": "Accessorial for describing the HAZMAT Class and UN Code for transportable goods."
      },
      "HazmatDetail": {
        "type": "object",
        "properties": {
          "hazardClass": {
            "type": "string",
            "description": "The hazard class number, according to the classification system outlined by the Federal Motor Carrier Safety Administration (FMCSA). This is a one digit number or a two digit number separated by a decimal."
          },
          "identificationNumber": {
            "type": "string",
            "description": "The United Nations (UN) or North America (NA) number identifying the hazmat item."
          },
          "properShippingName": {
            "type": "string",
            "description": "The proper shipping name of the hazardous item."
          },
          "packingGroup": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HazmatPackingGroup"
              }
            ],
            "description": "The packing group of the hazardous item."
          }
        }
      },
      "HazmatDetails": {
        "description": "Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.",
        "properties": {
          "code": {
            "description": "The hazard class number, according to the classification system outlined by the FederalMotor Carrier Safety Administration (FMCSA). This is a one digit number or a two digit number separated by a decimal.",
            "type": "string"
          },
          "emergencyContact": {
            "$ref": "#/components/schemas/Contact"
          },
          "identificationNumber": {
            "description": "The United Nations (UN) or North America (NA) number identifying the hazmat item.",
            "type": "string"
          },
          "packingGroup": {
            "description": "The hazmat packing group for a line item, indicating the degree of danger.",
            "enum": [
              "I",
              "II",
              "III",
              "NONE"
            ],
            "type": "string"
          },
          "properShippingName": {
            "description": "The proper shipping name of the hazmat item.",
            "type": "string"
          }
        },
        "title": "HazmatDetails",
        "type": "object"
      },
      "HazmatKind": {
        "required": [],
        "type": "object",
        "properties": {
          "hazmatClass": {
            "type": "string",
            "description": "The hazard class number, according to the classification system outlined by the Federal Motor Carrier Safety Administration (FMCSA). This is a one digit number or a two digit number separated by a decimal."
          },
          "unCode": {
            "type": "string",
            "description": "4-Digit UN Code."
          }
        },
        "additionalProperties": false
      },
      "HazmatPackingGroup": {
        "enum": [
          "I",
          "II",
          "III",
          "NONE"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Identifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/LogisticsIdentifierType"
              },
              {
                "$ref": "#/components/schemas/InternalEntityType"
              }
            ],
            "description": "The identifier type that can identify this entity."
          },
          "value": {
            "type": "string",
            "description": "Identifier."
          }
        }
      },
      "Identifiers": {
        "type": "object",
        "required": [],
        "properties": {
          "shipmentReference": {
            "type": "string",
            "description": "A unique reference number for the shipment. This is required for identifying the shipment associated with the appointment. Example: 'SHIP123456'.",
            "example": "SHIP123456"
          },
          "stopSequenceNumber": {
            "type": "integer",
            "minimum": 1,
            "description": "The sequence number of the stop for the shipment. Must be greater than 0. Used to identify a specific stop in a multi-stop shipment. Example: 1.",
            "example": 1
          },
          "siteCode": {
            "type": "string",
            "description": "The code identifying the site (facility, warehouse, or yard) where the appointment is scheduled. Used for location-based filtering and validation. Example: 'SITE001'.",
            "example": "SITE001"
          }
        },
        "anyOf": [
          {
            "required": [
              "stopSequenceNumber"
            ]
          },
          {
            "required": [
              "siteCode"
            ]
          }
        ]
      },
      "IdentifierWrapper": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Operator"
              }
            ],
            "default": "EQUALS"
          },
          "values": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Identifier"
            },
            "description": "List of logistics identifiers to search for"
          }
        }
      },
      "IdentifyingCodes": {
        "properties": {
          "codeListProvider": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CodeListProvider"
              }
            ],
            "description": "A list of codes identifying a party"
          },
          "codeListName": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CodeListName"
              }
            ],
            "description": "The name of the code list, code generation mechanism or code authority for the partyCode."
          },
          "partyCode": {
            "type": "string",
            "description": "Code to identify the party as provided by the code list provider"
          }
        },
        "type": "object",
        "required": []
      },
      "Image": {
        "required": [],
        "type": "object",
        "properties": {
          "mediaType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FileType"
              }
            ],
            "description": "The media type of this image."
          },
          "sizeInBytes": {
            "type": "integer",
            "description": "The file size of this image in bytes"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ImageType"
              }
            ],
            "description": "The image type of this image."
          },
          "url": {
            "type": "string",
            "description": "The url of this image."
          }
        }
      },
      "ImageApiConfiguration": {
        "description": "Contains fields used to configure the image API.",
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "ImageApiConfiguration",
        "type": "object"
      },
      "Images": {
        "required": [],
        "type": "object",
        "properties": {
          "email": {
            "$ref": "#/components/schemas/Email"
          },
          "includeBol": {
            "type": "boolean",
            "description": "Indicates whether or not you want an image of the populated BOL returned in the response.",
            "default": false
          },
          "includeShippingLabels": {
            "type": "boolean",
            "description": "Indicates whether or not you want image(s) of the shipping labels returned in the response.",
            "default": false
          },
          "shippingLabels": {
            "$ref": "#/components/schemas/ShippingLabels"
          }
        }
      },
      "ImageType": {
        "enum": [
          "ORIGINAL",
          "THUMBNAIL"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "IncotermType": {
        "enum": [
          "EXW",
          "FCA",
          "FAS",
          "FOB",
          "CFR",
          "CIF",
          "CPT",
          "CIP",
          "DPU",
          "DAP",
          "DDP"
        ],
        "type": "string",
        "description": "International commercial terms according to the [ICC](https://iccwbo.org/).\n\nEXW: EX WORKS, FCA: FREE CARRIER, FAS: FREE ALONGSIDE SHIP,\nFOB: FREE ON BOARD, CFR: COST & FREIGHT, CIF: COST, INSURANCE & FREIGHT\nCPT: COST PAID TO, CIP: CARRIER & INSURANCE PAID TO, DPU: DELIVERED AT PLACE UNLOADED\nDAP: DELIVERED AT PLACE, DDP: DELIVERED DUTY PAID"
      },
      "IntegerRange": {
        "description": "Integer Range that contains a maximum and minimum.",
        "properties": {
          "max": {
            "description": "Maximum integer in this range.",
            "format": "int32",
            "type": "integer"
          },
          "min": {
            "description": "Minimum integer in this range.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "IntegerRange",
        "type": "object"
      },
      "InternalEntityType": {
        "enum": [
          "MASTER_SHIPMENT_ID",
          "BOOKING_ID",
          "STOP_ID",
          "DRIVER_ID",
          "TRUCKLOAD_TRACKING_ID",
          "ORDER_ID",
          "SHIPPER_TENANT_UUID"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "InventoryContact": {
        "description": "Contact information.",
        "properties": {
          "companyName": {
            "description": "Company name.",
            "type": "string"
          },
          "contactName": {
            "description": "Contact name.  May be required for shipments.",
            "type": "string"
          },
          "contactType": {
            "enum": [
              "PRIMARY",
              "SECONDARY",
              "WAREHOUSE",
              "TRANSPORTATION",
              "FINANCE",
              "OTHER"
            ],
            "type": "string"
          },
          "email": {
            "description": "Email address.  May be required for shipments.",
            "type": "string"
          },
          "faxNumber": {
            "description": "Fax number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "faxNumberCountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          },
          "phoneNumber": {
            "description": "Phone number.  May be required  for shipments. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "phoneNumber2": {
            "description": "Alternate phone number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'.  If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'.",
            "type": "string"
          },
          "phoneNumber2CountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          },
          "phoneNumberCountryCode": {
            "description": "The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'.",
            "type": "string"
          }
        },
        "title": "InventoryContact",
        "type": "object"
      },
      "InventoryId": {
        "description": "Inventory Id model to hold the system generated unique id for inventory orders and items.",
        "properties": {
          "id": {
            "description": "The unique id string",
            "type": "string"
          }
        },
        "title": "InventoryId",
        "type": "object"
      },
      "InventoryIdentifier": {
        "description": "Details the identifiers of the inventory. The value and description pair can be applicable to Department, Category, Group, Family, Vendor, Manufacturer and Promotion",
        "properties": {
          "description": {
            "description": "The description for the identifier",
            "type": "string"
          },
          "type": {
            "description": "The type of the identifier",
            "enum": [
              "DEPARTMENT",
              "SUB_DEPARTMENT",
              "CATEGORY",
              "GROUP",
              "FAMILY",
              "GENDER",
              "VENDOR",
              "MANUFACTURER",
              "PROMOTION",
              "SECTOR",
              "DIVISION",
              "CLASS",
              "SUB_CLASS",
              "CODE",
              "SEASON"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value for the identifier",
            "type": "string"
          }
        },
        "title": "InventoryIdentifier",
        "type": "object"
      },
      "InventoryIdList": {
        "description": "List of Inventory Ids to hold system generated unique ids for inventory orders and items.",
        "properties": {
          "ids": {
            "description": "List of Inventory Ids to hold system generated unique ids for inventory orders and items.",
            "items": {
              "$ref": "#/components/schemas/InventoryId"
            },
            "type": "array"
          }
        },
        "title": "InventoryIdList",
        "type": "object"
      },
      "InventoryItem": {
        "description": "Inventory Item model that contains attribute describe different types of inventory items such as id, SKU (stock keeping unit), description, UPC (universal product code), cost/retail values, quantity, dim-weight (dimensional Weight), promotional windows (seasonal items), manufactured/packaged date-time, sellBy/consumedBy date-time, perishable/taxable flags, Hazardous material details, shipment/order list, etc.",
        "properties": {
          "consumeByDateTime": {
            "description": "The Consumed-By date-time for the inventory item. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "description": {
            "description": "The description of the inventory item",
            "type": "string"
          },
          "externalID": {
            "type": "string"
          },
          "id": {
            "description": "The unique identifier for one inventory item. This identifier should be treated as an opaque string and should be used to associate the inventory item to other orders and items.",
            "type": "string"
          },
          "inventoryDimensionalWeight": {
            "$ref": "#/components/schemas/DimensionalWeight"
          },
          "inventoryIdentifiers": {
            "description": "The customer-defined unique identifiers for the item",
            "items": {
              "$ref": "#/components/schemas/InventoryIdentifier"
            },
            "type": "array"
          },
          "lineItemHazmatDetail": {
            "$ref": "#/components/schemas/LineItemHazmatDetail"
          },
          "manufacturedDateTime": {
            "description": "The manufactured date-time for the inventory item. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "orderIds": {
            "description": "The list of order identifiers for the inventory item. These must be the unique project44-generated ids from the id field of orders in the system.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "packagedDateTime": {
            "description": "The packaged date-time for the inventory item. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "perUnitCost": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "perUnitRetailValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "perishable": {
            "description": "The flag to indicate if inventory item is perishable (default: 'false')",
            "type": "boolean"
          },
          "promotionalDateTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "sellByDateTime": {
            "description": "The Sell-By date-time for the inventory item. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "serialNumber": {
            "description": "A customer provided number that distinguishes identical goods or items.",
            "type": "string"
          },
          "shipmentIds": {
            "description": "The list of shipment identifiers associated with the inventory item. These values must be the project44-generated masterShipmentId from the shipments.",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "stockKeepingUnit": {
            "description": "The Stock Keeping Unit (aka SKU) is the common code used to represent goods or items.",
            "type": "string"
          },
          "taxable": {
            "description": "The flag to indicate if inventory item is taxable (default: 'false')",
            "type": "boolean"
          },
          "universalProductCode": {
            "description": "The Universal Product Code (aka UPC) is the bar code value used to represent goods or items.",
            "type": "string"
          }
        },
        "title": "InventoryItem",
        "type": "object"
      },
      "InventoryItemList": {
        "description": "List of Inventory Items.",
        "properties": {
          "items": {
            "description": "List of Inventory Items.",
            "items": {
              "$ref": "#/components/schemas/InventoryItem"
            },
            "maxItems": 500,
            "minItems": 0,
            "type": "array"
          }
        },
        "title": "InventoryItemList",
        "type": "object"
      },
      "InventoryItemPage": {
        "description": "A wrapper class for InventoryItem objects that represents a paginated response containing results and information about the current page.",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/InventoryItem"
            },
            "type": "array"
          }
        },
        "title": "InventoryItemPage",
        "type": "object"
      },
      "InventoryLocation": {
        "properties": {
          "additionalContacts": {
            "description": "Additional contact information at the location.",
            "items": {
              "$ref": "#/components/schemas/InventoryContact"
            },
            "type": "array"
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "contact": {
            "$ref": "#/components/schemas/InventoryContact"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "description": "Name of the location.",
            "type": "string"
          },
          "suppliedId": {
            "description": "Additional name or id of the location.",
            "type": "string"
          }
        },
        "title": "InventoryLocation",
        "type": "object"
      },
      "InventoryOrder": {
        "description": "Inventory Order model that contains attributes that describe different types of orders such as purchase order, sales order, advanced shipment notice, etc.",
        "properties": {
          "additionalOrderIdentifiers": {
            "description": "Semi-unique numbers or terms that describe orders. These are to be used in addition to the unique order object ID and can be used to search and filter. Examples include a vendor contract number (2108), or promotion specific term-number combination (Winter_1267).",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderIdentifier"
            },
            "type": "array"
          },
          "attributes": {
            "description": "An optional user-defined set of custom attributes to associate with this order. All attribute keys must be pre-defined by your organization's admin.",
            "items": {
              "$ref": "#/components/schemas/OrderCustomAttribute"
            },
            "type": "array"
          },
          "billToLocation": {
            "$ref": "#/components/schemas/InventoryLocation"
          },
          "createdDate": {
            "description": "The date that order created in project44 system. (format: yyyy-MM-dd, example: 2025-01-01).",
            "type": "string"
          },
          "deletedDateTime": {
            "description": "The date that the order is deleted. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "derivedOrderHealth": {
            "$ref": "#/components/schemas/DerivedOrderHealth"
          },
          "destinationLocation": {
            "$ref": "#/components/schemas/InventoryLocation"
          },
          "freightTerms": {
            "$ref": "#/components/schemas/FreightTerms"
          },
          "id": {
            "description": "Unique identifier to retrieve exactly one order.  This identifier should be treated as an opaque string and should be used to associate the InventoryOrder to other orders and items.",
            "type": "string"
          },
          "launchDateTime": {
            "description": "The date when a particular launch related to the overall order is expected. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "orderIdentifier": {
            "description": "Customer provided identifier. Always required.",
            "type": "string"
          },
          "orderIdentifierAuthority": {
            "description": "Optional customer provided field. The authority is the party responsible for managing creation of the order identifier.",
            "type": "string"
          },
          "orderSubmissionDateTime": {
            "description": "The date that the order is submitted. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "orderTags": {
            "description": "Non-unique numbers or terms that describe how orders are managed within the organization. These are to be used in addition to the unique order object ID and can be used to filter. The expanse of these terms are generally static and they are used when searching and filtering to a specific department, team, category, or provided identifier.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrderTag"
            },
            "type": "array"
          },
          "orderType": {
            "description": "The type of the InventoryOrder. Required if relying on order identifier to be unique.",
            "enum": [
              "PURCHASE_ORDER",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "INVOICE",
              "DELIVERY",
              "STOCK_TRANSFER_ORDER"
            ],
            "type": "string"
          },
          "originLocation": {
            "$ref": "#/components/schemas/InventoryLocation"
          },
          "originalDeliveryDateTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "relatedOrderIds": {
            "description": "Additional orders that can be related to this order. These ids must bethe project44-generated id from another order in the system.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "shipmentIds": {
            "description": "Project44-generated Ids of the associated shipments for the order. This field is deprecated. Shipment Loads should be used to link an order to shipments.",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "statusCode": {
            "description": "The stage of the order lifecycle that it is currently in",
            "enum": [
              "SUBMITTED",
              "RECEIVED",
              "PROCESSING",
              "ACCEPTED",
              "FULFILLED",
              "REJECTED",
              "CANCELED"
            ],
            "type": "string"
          },
          "statusCodeDateTime": {
            "description": "The date at which the status was generated or changed. This will bedefaulted to null unless provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "subject": {
            "description": "Descriptive name for a particular order such as 'Holiday Candles'",
            "type": "string"
          },
          "supplierReadyDateTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "totalCost": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "totalRetailValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "vendorLocation": {
            "$ref": "#/components/schemas/InventoryLocation"
          }
        },
        "title": "InventoryOrder",
        "type": "object"
      },
      "InventoryOrderAttributeFilter": {
        "properties": {
          "name": {
            "type": "string"
          },
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "values": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "InventoryOrderAttributeFilter",
        "type": "object"
      },
      "InventoryOrderIdentifier": {
        "description": "Inventory Order identifier model that contains additional identifiers with a type and a value.",
        "properties": {
          "type": {
            "description": "The type of the identifier",
            "enum": [
              "CONTRACT",
              "LOAD",
              "MANUFACTURER",
              "PROMOTION",
              "SEASON",
              "VENDOR",
              "LAUNCH_CODE",
              "CUSTOMER_ORDER"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the identifier",
            "type": "string"
          }
        },
        "title": "InventoryOrderIdentifier",
        "type": "object"
      },
      "InventoryOrderIdentifierCriteria": {
        "description": "Inventory order identifier criteria which allows you to search by type or value or the combination of both.",
        "properties": {
          "operator": {
            "description": "${InventoryOrderIdentifierCriteria.apiModel.operator.value}",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "description": "Limit search results to only orders with the provided identifier type. This search will be based on operator criterion provided if value is absent, otherwise default operator for a type given is EQUALS.",
            "enum": [
              "CONTRACT",
              "LOAD",
              "MANUFACTURER",
              "PROMOTION",
              "SEASON",
              "VENDOR",
              "LAUNCH_CODE",
              "CUSTOMER_ORDER"
            ],
            "type": "string"
          },
          "value": {
            "description": "Limit search results to only orders with the provided identifier value. This search will be based on operator criterion provided.",
            "type": "string"
          },
          "values": {
            "description": "Limit search results to only orders with the provided identifier values. This search will be based on operator criterion provided.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "InventoryOrderIdentifierCriteria",
        "type": "object"
      },
      "InventoryOrderPage": {
        "description": "A wrapper class for InventoryOrder objects that represents a paginated response containing results and information about the current page.",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrder"
            },
            "type": "array"
          }
        },
        "title": "InventoryOrderPage",
        "type": "object"
      },
      "InventoryOrderSortField": {
        "properties": {
          "direction": {
            "enum": [
              "ASC",
              "DESC"
            ],
            "type": "string"
          },
          "fieldName": {
            "enum": [
              "ORDER_TYPE",
              "ORDER_IDENTIFIER",
              "STATUS_CODE",
              "ORDER_SUBMISSION_DATETIME",
              "SUPPLIER_READY_WINDOW_START_DATETIME",
              "SUPPLIER_READY_WINDOW_END_DATETIME",
              "ORIGINAL_DELIVERY_WINDOW_START_DATETIME",
              "ORIGINAL_DELIVERY_WINDOW_END_DATETIME",
              "ORDER_HEALTH_ETA"
            ],
            "type": "string"
          }
        },
        "title": "InventoryOrderSortField",
        "type": "object"
      },
      "InventoryOrderTag": {
        "description": "Inventory order tag which contains type, value and description.",
        "properties": {
          "description": {
            "description": "The description of the tag",
            "type": "string"
          },
          "type": {
            "description": "The type of the tag",
            "enum": [
              "ANALYST",
              "CARRIER",
              "CATEGORY",
              "COMMODITY",
              "DEPARTMENT",
              "DIRECTOR",
              "FAMILY",
              "GROUP",
              "MANAGER",
              "SECTOR",
              "BATCH"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the tag",
            "type": "string"
          }
        },
        "title": "InventoryOrderTag",
        "type": "object"
      },
      "InventoryOrderTagCriteria": {
        "description": "Inventory order tag criteria which allows you to search by type or value or the combination of both.",
        "properties": {
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "description": "Limit search results to only orders with the provided tag type. This search will be based on operator criterion provided if value is absent, otherwise default operator for a type given is EQUALS.",
            "enum": [
              "ANALYST",
              "CARRIER",
              "CATEGORY",
              "COMMODITY",
              "DEPARTMENT",
              "DIRECTOR",
              "FAMILY",
              "GROUP",
              "MANAGER",
              "SECTOR",
              "BATCH"
            ],
            "type": "string"
          },
          "value": {
            "description": "Limit search results to only orders with the provided tag value. This search will be based on operator criterion provided.",
            "type": "string"
          },
          "values": {
            "description": "Limit search results to only orders with the provided tag values. This search will be based on operator criterion provided.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "InventoryOrderTagCriteria",
        "type": "object"
      },
      "Invitation": {
        "required": [],
        "type": "object",
        "properties": {
          "capability": {
            "type": "string",
            "description": "The capability which the invitation will provide.",
            "example": "TRUCKLOAD_ASSET_TRACKING",
            "enum": [
              "TRUCKLOAD_ASSET_TRACKING"
            ]
          },
          "createdDateTime": {
            "type": "string",
            "description": "The datetime when the invitation was created, in ISO-8601 format.",
            "format": "date-time",
            "readOnly": true,
            "example": "2023-08-23T10:15:30Z"
          },
          "invitee": {
            "$ref": "#/components/schemas/Invitee"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The datetime when the invitation was last modified, in ISO-8601 format.",
            "format": "date-time",
            "readOnly": true,
            "example": "2023-08-23T10:15:30Z"
          },
          "status": {
            "type": "string",
            "description": "The current status of the invitation.",
            "readOnly": true,
            "example": "ACCEPTED",
            "enum": [
              "ACCEPTED",
              "DECLINED",
              "IN_PROGRESS",
              "CANCELLED",
              "EXPIRED"
            ]
          }
        },
        "description": "List of invitations"
      },
      "InvitationContact": {
        "required": [],
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address of the contact."
          },
          "familyName": {
            "type": "string",
            "description": "The family name of the contact (surname, lastname)."
          },
          "givenName": {
            "type": "string",
            "description": "The given name of the contact (name, firstname)."
          },
          "locale": {
            "type": "string",
            "description": "The locale of the email which will be used to invite the contact, in BCP47 format."
          },
          "phone": {
            "type": "string",
            "description": "The phone number for the contact."
          }
        },
        "description": "Contact details of the invitee."
      },
      "InvitationOrganization": {
        "required": [],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Organization name."
          }
        },
        "description": "Organization details of the invitee."
      },
      "InvitationPage": {
        "type": "object",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "type": "array",
            "description": "List of invitations",
            "items": {
              "$ref": "#/components/schemas/Invitation"
            }
          }
        }
      },
      "Invitee": {
        "required": [],
        "type": "object",
        "properties": {
          "contacts": {
            "type": "array",
            "description": "Contact details of the invitee.",
            "items": {
              "$ref": "#/components/schemas/InvitationContact"
            }
          },
          "identifiers": {
            "type": "array",
            "description": "The identifiers of the invitee.",
            "items": {
              "$ref": "#/components/schemas/InviteeIdentifier"
            }
          },
          "organization": {
            "$ref": "#/components/schemas/InvitationOrganization"
          }
        },
        "description": "The entity being invited to provide the capability."
      },
      "InviteeIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Invitee identifier type.",
            "example": "VAT",
            "enum": [
              "VAT",
              "SCAC",
              "DOT_NUMBER",
              "MC_NUMBER",
              "P44_EU"
            ]
          },
          "value": {
            "type": "string",
            "description": "Invitee identifier value.",
            "example": "PL1234567890"
          }
        },
        "description": "The identifiers of the invitee."
      },
      "Item": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Free text space to describe the line-item."
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemIdentifier"
            },
            "description": "Useful identifiers that can be attached to this item. Identifiers with the following type codes will be used to create Items within the project44 platform: `STOCK_KEEPING_UNIT`, `UNIVERSAL_PRODUCT_CODE`, `UNKNOWN`. Identifiers with the following type codes will be used to reference Orders within the project44 platform: `PURCHASE_ORDER`, `SALES_ORDER`, `WAREHOUSE_MOVEMENT_ORDER`, `ADVANCED_SHIPMENT_NOTICE`, `INVOICE_NUMBER`. "
          },
          "unitQuantity": {
            "type": "integer",
            "description": "The quantity of identical packages that make up this item."
          },
          "unitType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackageContainerType"
              }
            ],
            "description": "The unit type of identical packages that make up this item."
          }
        },
        "description": "Item held within a larger handling unit."
      },
      "ItemIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ItemIdentifierType"
              }
            ],
            "description": "The identifier type used for this line item identifier."
          },
          "value": {
            "type": "string",
            "description": "The value used for this line item identifier."
          }
        }
      },
      "ItemIdentifierType": {
        "enum": [
          "CONTAINER_NUMBER",
          "PALLET_NUMBER",
          "DELIVERY_NUMBER",
          "PICKUP_NUMBER",
          "VEHICLE_IDENTIFICATION_NUMBER",
          "SERIAL_NUMBER",
          "PURCHASE_ORDER",
          "SALES_ORDER",
          "WAREHOUSE_MOVEMENT_ORDER",
          "ADVANCED_SHIPMENT_NOTICE",
          "INVOICE_NUMBER",
          "STOCK_KEEPING_UNIT",
          "UNIVERSAL_PRODUCT_CODE",
          "UNKNOWN"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Length": {
        "required": [],
        "type": "object",
        "properties": {
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LengthUnit"
              }
            ],
            "description": "The unit of measurement for this length."
          },
          "value": {
            "minimum": 0,
            "type": "number",
            "description": "The numeric decimal value of this length."
          }
        }
      },
      "LengthUnit": {
        "enum": [
          "FT",
          "M",
          "IN",
          "CM",
          "MI",
          "KM"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "LiftgateAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "LIFTGATE"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for liftgate service."
      },
      "LimitedAccessCode": {
        "enum": [
          "Airport",
          "Church",
          "Club",
          "Construction",
          "Fair",
          "Farm",
          "Hotel",
          "Mine",
          "Other",
          "Park",
          "Port",
          "School",
          "Secure",
          "Storage",
          "Tradeshow"
        ],
        "type": "string",
        "description": "Limited access codes"
      },
      "LimitedAccessType": {
        "type": "object",
        "properties": {
          "destination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LimitedAccessCode"
              }
            ],
            "description": "Optional attribute to indicate the limited access type when accessorial code LTDAD is present in the accessorial codes list."
          },
          "origin": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LimitedAccessCode"
              }
            ],
            "description": "Optional attribute to indicate the limited access type when accessorial code LTDAP is present in the accessorial codes list."
          }
        }
      },
      "LineItem": {
        "description": "An item of freight in a shipment.A line item consists of one or more packages, all of the same package type and with the same dimensions, freight class, and NMFC code. Each package, however, may have a different number of pieces and a different weight.",
        "properties": {
          "commodityType": {
            "description": "Commodity code identifying the type of shipment. Required for insurance quotes.",
            "type": "string"
          },
          "countryOfManufacture": {
            "description": "Country of manufacture of line item.",
            "enum": [
              "US",
              "CA",
              "MX",
              "AG",
              "BB",
              "BS",
              "BZ",
              "CR",
              "CU",
              "DM",
              "DO",
              "GD",
              "GT",
              "HN",
              "HT",
              "JM",
              "KN",
              "LC",
              "NI",
              "PA",
              "SV",
              "TT",
              "VC",
              "AI",
              "AW",
              "BL",
              "BM",
              "BQ",
              "CW",
              "GL",
              "GP",
              "KY",
              "MF",
              "MQ",
              "MS",
              "PM",
              "PR",
              "SX",
              "TC",
              "UM",
              "VG",
              "VI",
              "AT",
              "BE",
              "BG",
              "CY",
              "CZ",
              "DK",
              "DE",
              "EE",
              "ES",
              "FI",
              "FR",
              "GB",
              "GR",
              "HR",
              "HU",
              "IE",
              "IT",
              "LT",
              "LU",
              "LV",
              "MT",
              "NL",
              "PL",
              "PT",
              "RO",
              "SE",
              "SK",
              "SI",
              "CH",
              "IS",
              "LI",
              "NO",
              "AL",
              "ME",
              "MK",
              "RS",
              "TR",
              "AD",
              "AX",
              "BA",
              "BV",
              "BY",
              "FO",
              "GG",
              "GI",
              "IM",
              "IO",
              "JE",
              "MC",
              "MD",
              "SJ",
              "SM",
              "TF",
              "UA",
              "VA",
              "AE",
              "AF",
              "AM",
              "AZ",
              "BD",
              "BH",
              "BN",
              "BT",
              "CN",
              "GE",
              "HK",
              "ID",
              "IL",
              "IN",
              "IQ",
              "IR",
              "JO",
              "JP",
              "KG",
              "KH",
              "KP",
              "KR",
              "KW",
              "KZ",
              "LA",
              "LB",
              "LK",
              "MM",
              "MN",
              "MO",
              "MV",
              "MY",
              "NP",
              "OM",
              "PH",
              "PK",
              "PS",
              "QA",
              "RU",
              "SA",
              "SG",
              "SY",
              "TH",
              "TJ",
              "TL",
              "TM",
              "TW",
              "UZ",
              "VN",
              "YE",
              "AO",
              "BF",
              "BI",
              "BJ",
              "BW",
              "CD",
              "CF",
              "CG",
              "CI",
              "CM",
              "CV",
              "DJ",
              "DZ",
              "EG",
              "EH",
              "ER",
              "ET",
              "GA",
              "GH",
              "GM",
              "GN",
              "GQ",
              "GW",
              "HM",
              "KE",
              "KM",
              "LR",
              "LS",
              "LY",
              "MA",
              "MG",
              "ML",
              "MR",
              "MU",
              "MW",
              "MZ",
              "NA",
              "NE",
              "NG",
              "RE",
              "RW",
              "SC",
              "SD",
              "SH",
              "SL",
              "SN",
              "SO",
              "SS",
              "ST",
              "SZ",
              "TD",
              "TG",
              "TN",
              "TZ",
              "UG",
              "YT",
              "ZA",
              "ZM",
              "ZW",
              "AR",
              "BO",
              "BR",
              "CL",
              "CO",
              "EC",
              "FK",
              "GF",
              "GS",
              "GY",
              "PE",
              "PY",
              "SR",
              "UY",
              "VE",
              "AS",
              "AU",
              "CC",
              "CK",
              "CX",
              "FJ",
              "FM",
              "GU",
              "KI",
              "MH",
              "MP",
              "NC",
              "NF",
              "NR",
              "NU",
              "NZ",
              "PF",
              "PG",
              "PN",
              "PW",
              "SB",
              "TK",
              "TO",
              "TV",
              "VU",
              "WF",
              "WS",
              "AQ",
              "EL",
              "UK",
              "XK",
              "XS",
              "XI"
            ],
            "type": "string"
          },
          "description": {
            "description": "Readable description of this line item.",
            "type": "string"
          },
          "freightClass": {
            "description": "Freight class of all packages composing this item.  Required for LTL quotes and shipments only.",
            "enum": [
              "50",
              "55",
              "60",
              "65",
              "70",
              "77.5",
              "85",
              "92.5",
              "100",
              "110",
              "125",
              "150",
              "175",
              "200",
              "250",
              "300",
              "400",
              "500"
            ],
            "type": "string"
          },
          "harmonizedCode": {
            "description": "Harmonized System (HS) Code for the product as defined by the World Customers Organization, usually 6 characters in length, but up to 10 characters as defined by customs organizations by country. In the US, this would be the HTS or HTSA Code as defined by the US International Trade Commission.",
            "type": "string"
          },
          "hazmatDetail": {
            "$ref": "#/components/schemas/LineItemHazmatDetail"
          },
          "id": {
            "description": "The internal p44 id assigned to this line item. Provided only for insurance line items.",
            "format": "int64",
            "type": "integer"
          },
          "insuranceAmount": {
            "description": "The insurance amount claim of all pieces of the line item. Required for insurance quotes.",
            "type": "number"
          },
          "nmfcItemCode": {
            "description": "NMFC prefix code for all packages composing this line item.",
            "type": "string"
          },
          "nmfcSubCode": {
            "description": "NMFC suffix code for all packages composing this line item.",
            "type": "string"
          },
          "packageDimensions": {
            "$ref": "#/components/schemas/CubicDimension"
          },
          "packageType": {
            "description": "Type of packages composing this line item. (default: 'PLT')",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PAIL",
              "PLT",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TUBE",
              "EACH",
              "FLAT",
              "LOOSE"
            ],
            "type": "string"
          },
          "stackable": {
            "description": "Whether the packages composing this line item are stackable. (default: 'false')",
            "type": "boolean"
          },
          "totalPackages": {
            "description": "The number of packages composing this line item. (default: '1')",
            "format": "int32",
            "type": "integer"
          },
          "totalPieces": {
            "description": "The total number of pieces across all packages composing this line item. (default: '1')",
            "format": "int32",
            "type": "integer"
          },
          "totalValue": {
            "description": "The total value of all pieces of the line item. Required for insurance quotes.",
            "type": "number"
          },
          "totalWeight": {
            "description": "Total weight of all packages composing this line item.",
            "type": "number"
          }
        },
        "title": "LineItem",
        "type": "object"
      },
      "LineItemHazmatDetail": {
        "description": "Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.",
        "properties": {
          "hazardClass": {
            "description": "The hazard class number, according to the classification system outlined by the Federal Motor Carrier Safety Administration (FMCSA). This is a one digit number or a two digit number separated by a decimal.",
            "type": "string"
          },
          "identificationNumber": {
            "description": "The United Nations (UN) or North America (NA) number identifying the hazmat item.",
            "type": "string"
          },
          "packingGroup": {
            "description": "The hazmat packing group for a line item, indicating the degree of danger.",
            "enum": [
              "I",
              "II",
              "III",
              "NONE"
            ],
            "type": "string"
          },
          "properShippingName": {
            "description": "The proper shipping name of the hazmat item.",
            "type": "string"
          }
        },
        "title": "LineItemHazmatDetail",
        "type": "object"
      },
      "LineItemIdentifier": {
        "description": "A user defined identifier for this item.",
        "properties": {
          "type": {
            "description": "The identifier type  used for this line item identifier.",
            "enum": [
              "PURCHASE_ORDER",
              "SKU",
              "CONTAINER_NUMBER",
              "PALLET_NUMBER",
              "DELIVERY_NUMBER",
              "PICKUP_NUMBER",
              "VIN"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value used for this line item identifier.",
            "type": "string"
          }
        },
        "title": "LineItemIdentifier",
        "type": "object"
      },
      "LineItemLayoutType": {
        "enum": [
          "Nested",
          "Stacked"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Load": {
        "description": "A collection of goods that are being moved strictly from point A to point B. The collection of goods may contain many orders and many items of inventory and there is a single consignee for the load.  The load is tied to a shipment and exactly two stops.",
        "properties": {
          "createdDateTime": {
            "description": "The time of creation of load.",
            "type": "string"
          },
          "deletedDateTime": {
            "description": "The datetime of deletion of load.",
            "type": "string"
          },
          "deliveryStopReference": {
            "$ref": "#/components/schemas/StopReference"
          },
          "description": {
            "description": "A description of the overall load.",
            "type": "string"
          },
          "handlingUnits": {
            "$ref": "#/components/schemas/LoadHandlingUnits"
          },
          "id": {
            "description": "The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.",
            "format": "uuid",
            "type": "string"
          },
          "identifiers": {
            "description": "The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "type": "array"
          },
          "involvedParties": {
            "description": "Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "items": {
            "description": "A list of items contained within this load.",
            "items": {
              "$ref": "#/components/schemas/LoadItem"
            },
            "type": "array"
          },
          "masterShipmentId": {
            "description": "The project44-generated id of the shipment with which the load is associated.",
            "format": "uuid",
            "type": "string"
          },
          "pickupStopReference": {
            "$ref": "#/components/schemas/StopReference"
          }
        },
        "title": "Load",
        "type": "object"
      },
      "LoadCubicDimension": {
        "description": "Cubic dimensions of a handling unit",
        "properties": {
          "height": {
            "description": "Height of this cubic dimension.",
            "type": "number"
          },
          "length": {
            "description": "Length of this cubic dimension.",
            "type": "number"
          },
          "unit": {
            "description": "Unit of this cubic dimension.",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "width": {
            "description": "Width of this cubic dimension.",
            "type": "number"
          }
        },
        "title": "LoadCubicDimension",
        "type": "object"
      },
      "LoadHandlingUnits": {
        "description": "A description of handling units for a load",
        "properties": {
          "details": {
            "description": "A list of details that describe the specifics of the handling units for this load.",
            "items": {
              "$ref": "#/components/schemas/LoadHandlingUnitsDetails"
            },
            "type": "array"
          }
        },
        "title": "LoadHandlingUnits",
        "type": "object"
      },
      "LoadHandlingUnitsDetails": {
        "description": "Details of handling units for a load",
        "properties": {
          "cubicDimension": {
            "$ref": "#/components/schemas/LoadCubicDimension"
          },
          "handlingUnitType": {
            "description": "The type of packaging that best describes the handling unit.",
            "enum": [
              "BAG",
              "BALE",
              "BARREL",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PACK",
              "PAIL",
              "PALLET",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TRAY",
              "TUBE"
            ],
            "type": "string"
          },
          "quantity": {
            "description": "Quantity of the handling unit type that is specified below.",
            "format": "int64",
            "type": "integer"
          },
          "volume": {
            "$ref": "#/components/schemas/Volume"
          },
          "weight": {
            "$ref": "#/components/schemas/Weight"
          }
        },
        "title": "LoadHandlingUnitsDetails",
        "type": "object"
      },
      "LoadId": {
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          }
        },
        "title": "LoadId",
        "type": "object"
      },
      "LoadInformation": {
        "type": "object",
        "properties": {
          "productType": {
            "type": "string",
            "description": "Type of product",
            "example": "Laptop"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of the product",
            "example": 25
          },
          "sku": {
            "type": "string",
            "description": "Stock keeping unit",
            "example": "SKU123"
          }
        }
      },
      "LoadingMethod": {
        "enum": [
          "LIVE",
          "DROP"
        ],
        "type": "string",
        "description": "How the load is handled at this stop: LIVE (full load, driver waits) or DROP (power-only, drop trailer)."
      },
      "LoadItem": {
        "description": "A description of an inventory item that composes a load",
        "properties": {
          "description": {
            "description": "A description of this load item.",
            "type": "string"
          },
          "identifiers": {
            "description": "Unique load item identifiers containing a type (currently 'STOCK_KEEPING_UNIT', 'UNIVERSAL_PRODUCT_CODE', 'SERIAL_NUMBER' or 'EXTERNAL_ID') and a string value. EXTERNAL_ID is an external unique identifier of the item in customer's system.",
            "items": {
              "$ref": "#/components/schemas/LoadItemIdentifier"
            },
            "type": "array"
          },
          "orderIdentifierReferences": {
            "description": "A list of references to orders to which this load item pertains.",
            "items": {
              "$ref": "#/components/schemas/OrderIdentifierReference"
            },
            "type": "array"
          },
          "unitQuantity": {
            "description": "The quantity of identical packages that make up this load item.",
            "format": "int64",
            "type": "integer"
          },
          "unitType": {
            "description": "The unit type of identical packages that make up this load item.",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "PAIL",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "EACH",
              "FLAT",
              "LOOSE",
              "ROLL",
              "TUBE"
            ],
            "type": "string"
          }
        },
        "title": "LoadItem",
        "type": "object"
      },
      "LoadItemIdentifier": {
        "description": "Load item identifiers contain a type and a value",
        "properties": {
          "type": {
            "description": "unique field indicating the identifier type",
            "enum": [
              "STOCK_KEEPING_UNIT",
              "UNIVERSAL_PRODUCT_CODE",
              "SERIAL_NUMBER",
              "EXTERNAL_ID",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "value": {
            "description": "the string value corresponding to the type",
            "type": "string"
          }
        },
        "title": "LoadItemIdentifier",
        "type": "object"
      },
      "LoadPage": {
        "description": "A paginated response containing results and information about the current page.",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/Load"
            },
            "type": "array"
          }
        },
        "title": "LoadPage",
        "type": "object"
      },
      "LoadWebhookPayload": {
        "description": "Load webhook payload",
        "allOf": [
          {
            "$ref": "#/components/schemas/UnifiedWebhookInterface"
          },
          {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Load"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "dataType": {
                "type": "string",
                "enum": [
                  "Load"
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "eventType": {
                "type": "string",
                "enum": [
                  "inventory.v1.load.upserted",
                  "inventory.v1.load.deleted"
                ]
              }
            }
          }
        ]
      },
      "LocalDateTimeWindow": {
        "description": "A date and time range, local to the applicable location, representing a window of availability.",
        "properties": {
          "date": {
            "description": "Date for this time window in the timezone of the applicable location.(default: current date, format: yyyy-MM-dd)",
            "format": "date",
            "type": "string"
          },
          "endTime": {
            "description": "End time of this window in the timezone of the applicable location. (format: HH:mm)",
            "example": "17:00",
            "type": "string"
          },
          "startTime": {
            "description": "Start time of this window in the timezone of the applicable location. (format: HH:mm)",
            "example": "15:00",
            "type": "string"
          }
        },
        "title": "LocalDateTimeWindow",
        "type": "object"
      },
      "LocalTime": {
        "type": "object",
        "properties": {
          "hour": {
            "type": "integer",
            "format": "int32"
          },
          "minute": {
            "type": "integer",
            "format": "int32"
          },
          "nano": {
            "type": "integer",
            "format": "int32"
          },
          "second": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "Location": {
        "description": "A physical location.",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          }
        },
        "title": "Location",
        "type": "object"
      },
      "LocationCollection": {
        "description": "A collection of physical locations.",
        "properties": {
          "locations": {
            "description": "A collection of physical locations.",
            "items": {
              "$ref": "#/components/schemas/Location"
            },
            "type": "array"
          }
        },
        "title": "LocationCollection",
        "type": "object"
      },
      "LocationCriterion": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Some fields do not support the CONTAINS operator.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "propertyName": {
            "type": "string",
            "deprecated": true,
            "enum": [
              "LOCATION_NAME",
              "LOCATION_ADDRESS",
              "LOCATION_CITY",
              "LOCATION_STATE",
              "LOCATION_COUNTRY",
              "LOCATION_ZIP"
            ]
          },
          "propertyNames": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "LOCATION_NAME",
                "LOCATION_ADDRESS",
                "LOCATION_CITY",
                "LOCATION_STATE",
                "LOCATION_COUNTRY",
                "LOCATION_ZIP"
              ]
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on a location property. The property to match against is specified as the propertyName(s). At least one of [propertyName, propertyNames] is required.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (location.{field} EQUALS [A OR B OR C])\n\nExample: (location.{field} NOT_EQUALS A) AND (location.{field} NOT_EQUALS B)"
      },
      "LocationIdentifier": {
        "description": "Location Identifier pair that contains the type and value. The identified Stop Location must have been previously created via the STOP LOCATION MANAGEMENT API, and the Stop Location must have an associated Contact created with the CAPACITY PROVIDER CONTACT MANAGEMENT API.",
        "properties": {
          "type": {
            "description": "The type of the location identifier. Must be either SYSTEM (Project44-supplied) or EXTERNAL (customer-supplied).",
            "enum": [
              "EXTERNAL",
              "SYSTEM"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the location identifier.",
            "type": "string"
          }
        },
        "title": "LocationIdentifier",
        "type": "object"
      },
      "LocationIdentifierCriterion": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "If values is not populated, the CONTAINS operator is not supported.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "AIRPORT_IATA",
                "AIRPORT_ICAO",
                "EXTERNAL",
                "LOCODE",
                "NAME",
                "PORT_UN_LOCODE",
                "FACILITY_ID",
                "RAIL_SPLC",
                "RAIL_UIC",
                "RAIL_EU_PLC",
                "UNKNOWN"
              ]
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of stop location identifiers.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the type and values, and they are combined using an AND operator.\n\nExample: \n\n(identifier.type EQUALS X AND identifier.value EQUALS [A OR B OR C]) AND \n\n(identifier.type EQUALS Y AND identifier.value EQUALS [D OR F])"
      },
      "LocationIdentifierType": {
        "enum": [
          "UNKNOWN",
          "AIRPORT_IATA",
          "AIRPORT_ICAO",
          "PORT_UN_LOCODE",
          "RAIL_SPLC",
          "DATA_PROVIDER_LOCATION_CODE",
          "LOCODE"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "LockedGateAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "LOCKED_GATE"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for locked gate service."
      },
      "LogisticsIdentifier": {
        "description": "Any standardized 3rd party identifier. Can be used to identifier a shipment, freight, vehicle, carrier, or other freight entity.",
        "properties": {
          "type": {
            "description": "The standard which defines who assigns the identifier and what it identifies. Required field.",
            "enum": [
              "AIR_WAYBILL",
              "BILL_OF_LADING",
              "HOUSE_BILL_OF_LADING",
              "BOOKING_NUMBER",
              "CARRIER_IATA",
              "CARRIER_ICAO",
              "CARRIER_NAME",
              "CARRIER_SCAC",
              "FFW_SCAC",
              "NVOCC_SCAC",
              "NVOCC_NAME",
              "FFW_NAME",
              "FFW_MASTER_ID",
              "NVOCC_MASTER_ID",
              "CONTAINER_ID",
              "CUSTOMER_REFERENCE",
              "DELIVERY_NUMBER",
              "EXTERNAL",
              "FLIGHT_NUMBER",
              "ORDER",
              "PICKUP",
              "PRO",
              "PURCHASE_ORDER",
              "RAIL_CAR_ID",
              "RAIL_WAYBILL",
              "TRACKING_NUMBER",
              "TRAILER_ID",
              "UNKNOWN",
              "VESSEL_IMO",
              "VESSEL_NAME",
              "WAYBILL",
              "VESSEL_CALL_SIGN",
              "VESSEL_MMSI",
              "CARRIER_US_DOT_NUMBER",
              "CARRIER_MC_NUMBER",
              "SUBSCRIPTION_ID",
              "HOUSE_AIR_WAYBILL",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "DRIVER_MOBILE_PHONE_NUMBER",
              "VEHICLE_ID",
              "LICENSE_PLATE",
              "TRAILER_LICENSE_PLATE",
              "SENSITECH_DEVICE_ID",
              "EMERSON_DEVICE_ID",
              "TIVE_DEVICE_ID",
              "ZILLION_DEVICE_ID",
              "VOYAGE_NUMBER",
              "CARRIER_MASTER_ID",
              "CARRIER_NMC_ID",
              "CONTAINER_TYPE",
              "TRAIN_NUMBER",
              "WAGON_ID",
              "TRAIN_ID",
              "CAPACITY_PROVIDER_ACCOUNT_GROUP",
              "CAPACITY_PROVIDER_ACCOUNT_CODE",
              "SERIAL_NUMBER",
              "VEHICLE_IDENTIFICATION_NUMBER",
              "REFERENCE_NUMBER",
              "CONTAINER_PIN",
              "VESSEL_P44_ID",
              "EXPORT_CUSTOMS_BROKER",
              "IMPORT_CUSTOMS_BROKER",
              "POL_QUALITY_CONTROL_PROVIDER",
              "POD_QUALITY_CONTROL_PROVIDER",
              "AIRCRAFT_ICAO",
              "AIRLINE_NAME",
              "SEAL_NUMBER",
              "DRAYAGE_CARRIER_SCAC",
              "EXPORT_DRAYAGE_CARRIER_SCAC",
              "IMPORT_DRAYAGE_CARRIER_SCAC"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of this identifier. Required field.",
            "type": "string"
          }
        },
        "title": "LogisticsIdentifier",
        "type": "object"
      },
      "LogisticsIdentifierType": {
        "enum": [
          "AIR_WAYBILL",
          "BILL_OF_LADING",
          "HOUSE_BILL_OF_LADING",
          "BOOKING_NUMBER",
          "CARRIER_IATA",
          "CARRIER_ICAO",
          "CARRIER_NAME",
          "CARRIER_SCAC",
          "FFW_SCAC",
          "CONTAINER_ID",
          "CUSTOMER_REFERENCE",
          "DELIVERY_NUMBER",
          "EXTERNAL",
          "FLIGHT_NUMBER",
          "ORDER",
          "PICKUP",
          "PRO",
          "PURCHASE_ORDER",
          "RAIL_CAR_ID",
          "RAIL_WAYBILL",
          "TRACKING_NUMBER",
          "TRAILER_ID",
          "UNKNOWN",
          "VESSEL_IMO",
          "VESSEL_NAME",
          "WAYBILL",
          "VESSEL_CALL_SIGN",
          "VESSEL_MMSI",
          "CARRIER_US_DOT_NUMBER",
          "CARRIER_MC_NUMBER",
          "SUBSCRIPTION_ID",
          "HOUSE_AIR_WAYBILL",
          "SALES_ORDER",
          "WAREHOUSE_MOVEMENT_ORDER",
          "ADVANCED_SHIPMENT_NOTICE",
          "DRIVER_MOBILE_PHONE_NUMBER",
          "VEHICLE_ID",
          "LICENSE_PLATE",
          "SENSITECH_DEVICE_ID",
          "EMERSON_DEVICE_ID",
          "TIVE_DEVICE_ID",
          "VOYAGE_NUMBER",
          "CARRIER_MASTER_ID",
          "CARRIER_NMC_ID",
          "CONTAINER_TYPE",
          "TRAIN_NUMBER",
          "WAGON_ID",
          "CAPACITY_PROVIDER_ACCOUNT_GROUP",
          "CAPACITY_PROVIDER_ACCOUNT_CODE",
          "SERIAL_NUMBER",
          "VEHICLE_IDENTIFICATION_NUMBER",
          "REFERENCE_NUMBER",
          "CONTAINER_PIN",
          "INVOICE_ID",
          "VESSEL_P44_ID"
        ],
        "type": "string",
        "description": "The type of identifier provided to distinguish the Shipment."
      },
      "LogisticsIdentifierTypeEnum": {
        "type": "string",
        "description": "The standard which defines who assigns the identifier and what it identifies. Required field.",
        "enum": [
          "AIR_WAYBILL",
          "BILL_OF_LADING",
          "HOUSE_BILL_OF_LADING",
          "BOOKING_NUMBER",
          "CARRIER_IATA",
          "CARRIER_ICAO",
          "CARRIER_NAME",
          "CARRIER_SCAC",
          "FFW_SCAC",
          "NVOCC_SCAC",
          "NVOCC_NAME",
          "FFW_NAME",
          "FFW_MASTER_ID",
          "NVOCC_MASTER_ID",
          "CONTAINER_ID",
          "CUSTOMER_REFERENCE",
          "DELIVERY_NUMBER",
          "EXTERNAL",
          "FLIGHT_NUMBER",
          "ORDER",
          "PICKUP",
          "PRO",
          "PURCHASE_ORDER",
          "RAIL_CAR_ID",
          "RAIL_WAYBILL",
          "TRACKING_NUMBER",
          "TRAILER_ID",
          "UNKNOWN",
          "VESSEL_IMO",
          "VESSEL_NAME",
          "WAYBILL",
          "VESSEL_CALL_SIGN",
          "VESSEL_MMSI",
          "CARRIER_US_DOT_NUMBER",
          "CARRIER_MC_NUMBER",
          "SUBSCRIPTION_ID",
          "HOUSE_AIR_WAYBILL",
          "SALES_ORDER",
          "WAREHOUSE_MOVEMENT_ORDER",
          "ADVANCED_SHIPMENT_NOTICE",
          "DRIVER_MOBILE_PHONE_NUMBER",
          "VEHICLE_ID",
          "LICENSE_PLATE",
          "SENSITECH_DEVICE_ID",
          "EMERSON_DEVICE_ID",
          "TIVE_DEVICE_ID",
          "ZILLION_DEVICE_ID",
          "VOYAGE_NUMBER",
          "CARRIER_MASTER_ID",
          "CARRIER_NMC_ID",
          "CONTAINER_TYPE",
          "TRAIN_NUMBER",
          "WAGON_ID",
          "TRAIN_ID",
          "CAPACITY_PROVIDER_ACCOUNT_GROUP",
          "CAPACITY_PROVIDER_ACCOUNT_CODE",
          "SERIAL_NUMBER",
          "VEHICLE_IDENTIFICATION_NUMBER",
          "REFERENCE_NUMBER",
          "CONTAINER_PIN",
          "VESSEL_P44_ID",
          "EXPORT_CUSTOMS_BROKER",
          "IMPORT_CUSTOMS_BROKER",
          "POL_QUALITY_CONTROL_PROVIDER",
          "POD_QUALITY_CONTROL_PROVIDER",
          "AIRCRAFT_ICAO",
          "AIRLINE_NAME",
          "SEAL_NUMBER",
          "DRAYAGE_CARRIER_SCAC",
          "EXPORT_DRAYAGE_CARRIER_SCAC",
          "IMPORT_DRAYAGE_CARRIER_SCAC"
        ]
      },
      "LtlAdditionalAppointmentWindow": {
        "description": "A user defined appointment window to be used in lists.",
        "properties": {
          "appointmentStatus": {
            "description": "This is the state of the appointment as determined by the source appointment management system. This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment.",
            "enum": [
              "PENDING",
              "REJECTED",
              "BOOKED",
              "CANCELLED",
              "COMPLETED",
              "PENDING_CARRIER",
              "PENDING_INTERNAL",
              "NONE_AVAILABLE"
            ],
            "type": "string"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "identifiers": {
            "description": "A list of identifiers of the additional appointment windows to a shipment.",
            "items": {
              "$ref": "#/components/schemas/AdditionalAppointmentWindowIdentifier"
            },
            "type": "array"
          },
          "type": {
            "description": "The type of appointment window.",
            "enum": [
              "STRATEGIC",
              "SLOT_BOOKING_PICKUP",
              "SLOT_BOOKING_DELIVERY",
              "SLOT_BOOKING_PICKUP_DELIVERY"
            ],
            "type": "string"
          }
        },
        "title": "LtlAdditionalAppointmentWindow",
        "type": "object"
      },
      "LtlCapacityProviderPushShipment": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerAccount": {
            "$ref": "#/components/schemas/CustomerAccount"
          },
          "shipmentIdentifiers": {
            "description": "A list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment. At least one identifier of type 'PRO' must be included in the list. The source field cannot be provided in this API.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "description": "A list of the shipment stops for the shipment. When stop data is provided, there must be at least two stops -- one of type 'ORIGIN' and one of type 'DESTINATION'. 'ORIGIN' and 'DESTINATION' stops must have location address information including addressLines, city, state, country, postalCode and location contact information including companyName.\nStops of type 'TERMINAL' (service center) may be included or added as the shipment is tracked and they are discovered. 'TERMINAL' stops must have location address information including city, state, country, postalCode and location contact information including companyName. 'TERMINAL' stops must also have terminalCode. All stop types require a stop number. The stop number represents the order for which the stops will be visited. Besides 'ORIGIN' always being stopNumber: 1, stopNumber may change as 'TERMINAL's are discovered throughout tracking (i.e. initially there may only be two known stops; 'ORIGIN' with stopNumber 1 and 'DESTINATION' with stopNumber 2. Once a 'TERMINAL' stop is discovered, the 'DESTINATION' stop will now have stopNumber 3. Stop objects contain an object called 'appointmentWindow'. These appointment windows are the requested appointment windows found on the bill of lading. If the stop type is 'ORIGIN', it is a requested pickup appointment window and if the stop type is 'DESTINATION', it is a requested delivery appointment window.",
            "items": {
              "$ref": "#/components/schemas/LtlTrackedShipmentStop"
            },
            "type": "array"
          },
          "sourceType": {
            "description": "The original type of data source for where this shipment originated from. (default: API)",
            "enum": [
              "API",
              "EDI"
            ],
            "type": "string"
          },
          "transitDays": {
            "description": "The number of days it will take to deliver the load after pickup.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "LtlCapacityProviderPushShipment",
        "type": "object"
      },
      "LtlCapacityProviderPushShipmentArrivalEstimate": {
        "properties": {
          "estimatedArrivalWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          }
        },
        "title": "LtlCapacityProviderPushShipmentArrivalEstimate",
        "type": "object"
      },
      "LtlCapacityProviderPushStatusReason": {
        "properties": {
          "description": {
            "description": "A description of the reason for the status of the status update.",
            "type": "string"
          },
          "reasonDetailCode": {
            "description": "The reason detail code for the status of the status udpate.",
            "enum": [
              "APPOINTMENT_SET",
              "CANNOT_FIND_CONSIGNEE_ADDRESS",
              "CANNOT_REACH_CONSIGNEE",
              "CONS_CLOSED_FOR_HOLIDAY",
              "CONS_DID_NOT_ORDER_FREIGHT",
              "CONSIGNEE_CANCELLED_ORDER",
              "CONSIGNEE_CLOSED",
              "CONSIGNEE_DISPUTES_CHARGES",
              "CREDIT_HOLD",
              "DAMAGED",
              "DAMAGED_ON_DELIVERY",
              "DELIVERY_ATTEMPTED_APPOINTMENT",
              "DELIVERY_ATTEMPTED_NO_DOCK_SPACE",
              "DELIVERY_ATTEMPTED_REAR_LOAD",
              "DELIVERY_REQUIRES_SPECIAL_EQUIPMENT",
              "DELIVERY_SHORTAGE",
              "DUPLICATE_SHIPMENT",
              "EMERGENCY_DELAY_IN_TRANSIT",
              "GENERAL_EXCEPTION",
              "HAZARDOUS_MATERIAL",
              "INCORRECT_ADDRESS_PROVIDED",
              "INVALID_OR_MISSING_PURCHASE_ORDER_NUMBER",
              "LIMITED_ACCESS_LOCATIONS",
              "MISSING_PACKING_LIST",
              "NO_PAYMENT_AVAILABLE_AT_DELIVERY",
              "OVERAGE",
              "PERMANENT_APPOINTMENT_REQUIRED",
              "PROTECTIVE_SERVICE_REQUIRED",
              "RECONSIGNED_TO_NEW_CONSIGNEE",
              "REFUSED_BY_CONS_CANNOT_RECEIVE_ON_DELIVERY_DATE",
              "REFUSED_NO_RETURN_AUTHORIZATION",
              "SHIP_WHEN_CAPACITY_AVAILABLE",
              "SHIPMENT_ALASKA_OR_HAWAII",
              "SHIPMENT_TENDERED_LATE",
              "SHORTAGE",
              "SPOT_MARKET_SHIPMENT",
              "WAITING_INSTRUCTIONS",
              "WEATHER_DELAY",
              "WEATHER_DELAY_CLEARED",
              "WORK_STOPPAGE",
              "WRONG_PRODUCT_SHIPPED"
            ],
            "type": "string"
          },
          "reasonSummaryCode": {
            "description": "The reason summary code for the status of the status update.",
            "enum": [
              "APPOINTMENT_ISSUE",
              "BILLING_ISSUE",
              "DELIVERY_ISSUE",
              "INFO_MESSAGE",
              "OTHER_EXCEPTION",
              "PAPERWORK_ISSUE",
              "SHIPMENT_ISSUE",
              "SPOT_SHIPMENT",
              "STAFFING_ISSUE",
              "TRANSIT_ISSUE",
              "VEHICLE_ISSUE",
              "WEATHER_ISSUE"
            ],
            "type": "string"
          }
        },
        "title": "LtlCapacityProviderPushStatusReason",
        "type": "object"
      },
      "LtlCapacityProviderPushStatusUpdate": {
        "properties": {
          "arrivalEstimate": {
            "$ref": "#/components/schemas/LtlCapacityProviderPushShipmentArrivalEstimate"
          },
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerAccount": {
            "$ref": "#/components/schemas/CustomerAccount"
          },
          "deliveryAppointmentWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "proIdentifier": {
            "$ref": "#/components/schemas/LtlShipmentIdentifier"
          },
          "shipmentIdentifiers": {
            "description": "A list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment. At least one identifier of type 'PRO' must be included in the list. The source field cannot be provided in this API.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          },
          "sourceType": {
            "description": "The original type of data source for where this status update originated from. (default: API)",
            "enum": [
              "API",
              "EDI"
            ],
            "type": "string"
          },
          "statusCode": {
            "description": "The project44 status code for this status update. This field must always be populated.",
            "enum": [
              "READY_FOR_PICKUP",
              "UPDATED_PICKUP_APPT",
              "EXCEPTION",
              "PICKED_UP",
              "ARRIVED_AT_TERMINAL",
              "REWEIGHT_RECLASS",
              "INFO",
              "UPDATED_DELIVERY_APPT",
              "DEPARTED_TERMINAL",
              "OUT_FOR_DELIVERY",
              "DELIVERED"
            ],
            "type": "string"
          },
          "statusReason": {
            "$ref": "#/components/schemas/LtlCapacityProviderPushStatusReason"
          },
          "stopNumber": {
            "description": "The stop number, where '1' is the origin and the destination has the largest number, with any stops in between ordered by appointment time.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of the shipment stop to which this status update corresponds, if any. For example, a status update with code 'AT_STOP' will typically have this field populated with the stop type the vehicle is at.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          },
          "terminalCode": {
            "description": "The service center's code. For example, the capacity provider's service center in Miami may have a code like 'MIA-123' or 'MIA'. This should match a stop code of one of the shipment stop's stop codes.",
            "type": "string"
          },
          "timestamp": {
            "description": "The timestamp of this status update in the time zone of the location (format: yyyy-MM-dd'T'HH:mm:ssZ). If this status update has no location, the time zone should be UTC.",
            "type": "string"
          }
        },
        "title": "LtlCapacityProviderPushStatusUpdate",
        "type": "object"
      },
      "LtlDetails": {
        "type": "object",
        "properties": {
          "capacityProviderAccountGroup": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CapacityProviderAccountGroup"
              }
            ],
            "description": "The requested capacity provider account group containing the account used for authentication with the capacity provider's API."
          }
        }
      },
      "LtlDispatchedShipment": {
        "description": "Shipment request used to initiate a shipment.",
        "properties": {
          "accessorialServices": {
            "description": "List of accessorial services to be requested for this shipment. Some capacity providers support accessorial services without providing a way of requesting them through their API. To handle this, project44 sends these accessorial services through the capacity provider's pickup note API field, according to the shipment note configuration.",
            "items": {
              "$ref": "#/components/schemas/AccessorialService"
            },
            "type": "array"
          },
          "apiConfiguration": {
            "$ref": "#/components/schemas/ShipmentApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "capacityProviderQuoteNumber": {
            "description": "The quote number for this shipment assigned by the capacity provider. Only a few LTL capacity providers accept a quote number when placing a shipment for pickup. Most volume LTL capacity providers, however, require a quote number.",
            "type": "string"
          },
          "carrierCode": {
            "description": "SCAC of the carrier that is to pick up this shipment. Required only for capacity providers that support multiple SCACs.",
            "type": "string"
          },
          "currencyCode": {
            "description": "Line items monetary value currency, contains optional currency code (ex. 'USD'). This functionality is typically used with cross-border shipments.",
            "enum": [
              "USD",
              "CAD",
              "MXN",
              "EUR"
            ],
            "type": "string"
          },
          "customsInfo": {
            "$ref": "#/components/schemas/CustomsInfo"
          },
          "deliveryNote": {
            "description": "Note that applies to the delivery of this shipment. Currently, since nearly all capacity provider APIs have only a pickup note field and not a delivery note field, this delivery note will be inserted into the capacity provider's pickup note API field, according to the shipment note configuration.",
            "type": "string"
          },
          "deliveryWindow": {
            "$ref": "#/components/schemas/LocalDateTimeWindow"
          },
          "destinationInvolvedParties": {
            "description": "A list of parties and their identifiers related to the destination location. These are typically your customers receiving freight at the destination.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "destinationLocation": {
            "$ref": "#/components/schemas/Location"
          },
          "directionOverride": {
            "description": "An override of direction for the capacity provider account used by this request, if it has 'Enable API override of direction' set as 'true' in the project44 Self-Service Portal.This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.",
            "enum": [
              "SHIPPER",
              "CONSIGNEE",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "emergencyContact": {
            "$ref": "#/components/schemas/Contact"
          },
          "enhancedHandlingUnits": {
            "description": "A more granular representation of a line item. Required if no lineItems. Allows for order level tracking, more accurate rates, and more detailed BOLs. Currently not supported by all vendors. An enhancedHandlingUnit consists of one or more handling units, e.g. a pallet or a drum, one or more packages (the container on the handling unit e.g. a box), and package contents. NMFC codes and freight classes can be assigned at the handling unit and package level, while package contents can be associated with a DELIVERY_NUMBER, SKU_NUMBER, or PURCHASE_ORDER_NUMBER. Passing in both this field and lineItems is accepted, but at least one is required.",
            "items": {
              "$ref": "#/components/schemas/HandlingUnit"
            },
            "type": "array"
          },
          "handlingUnitTypeQuantities": {
            "description": "A list of the quantity of certain handling unit types. If there are multiple types of handling units e.g. pallet, drum, box, the quantity of each handling unit type should be specified.",
            "items": {
              "$ref": "#/components/schemas/HandlingUnitTypeQuantity"
            },
            "type": "array"
          },
          "lengthUnit": {
            "description": "Length measurement unit for all length values in this shipment request. (default: 'IN')",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "lineItems": {
            "description": "The line items to be shipped.A line item consists of one or more packages, all of the same package type and with the same dimensions, freight class, and NMFC code. Each package, however, may have a different number of pieces and a different weight. Note that each capacity provider has a different maximum number of line items that they can accept. NOTE: This field is similar to, but not the same as, the enhancedHandlingUnits field. The enhancedHandlingUnits fields can contain more detailed information for use by both the carrier and the shipper.",
            "items": {
              "$ref": "#/components/schemas/LineItem"
            },
            "type": "array"
          },
          "originInvolvedParties": {
            "description": "A list of parties and their identifiers related to the origin location. These are typically your suppliers providing freight at the origin.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "originLocation": {
            "$ref": "#/components/schemas/Location"
          },
          "paymentTermsOverride": {
            "description": "An override of payment terms for the capacity provider account used by this request, if it has 'Enable API override of payment terms' set as 'true' in the project44 Self-Service Portal. This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.",
            "enum": [
              "PREPAID",
              "COLLECT",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "pickupNote": {
            "description": "Note that applies to the pickup of this shipment. The shipment note configuration determines the final pickup note that is sent through the capacity provider's API and whether or not part of it may be cut off.",
            "type": "string"
          },
          "pickupWindow": {
            "$ref": "#/components/schemas/LocalDateTimeWindow"
          },
          "rateQuoteId": {
            "description": "The quote ID from project44. This is an optional field.",
            "type": "string"
          },
          "requesterLocation": {
            "$ref": "#/components/schemas/Location"
          },
          "shipmentIdentifiers": {
            "description": "A list of identifiers or reference numbers for this shipment. Most capacity providers accept only identifiers of types 'BILL_OF_LADING', 'PURCHASE_ORDER', and 'CUSTOMER_REFERENCE'. Only one identifier of each type may be provided. An identifier of type 'SYSTEM_GENERATED' may not be provided. An identifier of type 'EXTERNAL' may be provided and subsequently tracked with through project44 -- this identifier will not be communicated to the capacity provider.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          },
          "totalHandlingUnits": {
            "description": "Total numbers of packaged units that are expected to be shipped. This should match the number of units a driver should be loading onto the truck.",
            "format": "int32",
            "type": "integer"
          },
          "totalLinearFeet": {
            "description": "The total linear feet that the shipment being quoted will take up in a trailer. Only for volume LTL shipments.",
            "format": "int32",
            "type": "integer"
          },
          "weightUnit": {
            "description": "Weight measurement unit for all weight values in this shipment request. (default: 'LB')",
            "enum": [
              "LB",
              "KG"
            ],
            "type": "string"
          }
        },
        "title": "LtlDispatchedShipment",
        "type": "object"
      },
      "LtlDispatchedShipmentConfirmation": {
        "description": "Confirmation of a shipment to be tendered by a carrier, including assigned shipment identifiers.",
        "properties": {
          "capacityProviderBolUrl": {
            "description": "URL pointing to a PDF document of the capacity provider's Bill of Lading, if available.",
            "type": "string"
          },
          "id": {
            "description": "The id of the dispatched shipment.",
            "format": "int64",
            "type": "integer"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "packingVisualizationUrl": {
            "description": "Customers who have enabled our Volume Visualizer product will find a URL to a PDF document illustrating the optimized item arrangement, for the shipment's total linear footage value. (Example: https://na12.api.project44.com/unauthenticated/linear-feet/pdf/{linearFeetVisualizationId})",
            "type": "string"
          },
          "pickupDateTime": {
            "description": "The pickup date and time as provided by the capacity provider in the timezone of origin location of the shipment. (format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "pickupNote": {
            "description": "The final note that was sent through the capacity provider's pickup note API field, as constructed by project44 according to the requested shipment note configuration.",
            "type": "string"
          },
          "shipmentIdentifiers": {
            "description": "A list of identifiers for the confirmed shipment. Nearly all capacity providers provide a pickup confirmation number, which will appear in this list with type 'PICKUP'. A few capacity providers also provide a PRO number when a shipment is confirmed. Shipment identifiers provided by the customer will show up here, as well.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "LtlDispatchedShipmentConfirmation",
        "type": "object"
      },
      "LtlImageQuery": {
        "description": "Request an image of a document related to a shipment.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/ImageApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "destinationAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "documentType": {
            "description": "A code for the requested image's document type.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for the format of the image to be returned. The capacity provider's image will be converted to this format. (default: 'PNG')",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "pickupDate": {
            "description": "The date this shipment was picked up by carrier. Some carriers require this to aid in retrieving documents. (format: yyyy-MM-dd)",
            "format": "date",
            "type": "string"
          },
          "proNumber": {
            "description": "PRO number identifying the shipment related to the requested image.",
            "type": "string"
          }
        },
        "title": "LtlImageQuery",
        "type": "object"
      },
      "LtlImageReference": {
        "description": "Reference to an image of a document related to a shipment.",
        "properties": {
          "documentType": {
            "description": "A code for this image's document type, matching what was requested.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for this image's format, matching what was requested.",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "imageUrl": {
            "description": "The web URL for accessing this image.",
            "type": "string"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "proNumber": {
            "description": "PRO number identifying the shipment related to the requested image. This may be slightly different than the requested PRO number, depending on the capacity provider (e.g., leading zeros may be missing).",
            "type": "string"
          }
        },
        "title": "LtlImageReference",
        "type": "object"
      },
      "LtlShipmentArrivalEstimate": {
        "properties": {
          "estimatedArrivalWindow": {
            "$ref": "#/components/schemas/SplitOffsetDateTimeWindow"
          }
        },
        "title": "LtlShipmentArrivalEstimate",
        "type": "object"
      },
      "LtlShipmentCancellation": {
        "description": "Request containing shipment identifiers identifying a shipment dispatch to cancel.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/LtlShipmentCancellationApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "originAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "shipmentIdentifiers": {
            "description": "A list of identifiers of the dispatched LTL shipment to be cancelled. Currently only one can be provided. This may not be provided when cancelling a shipment by the project44-generated id.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "LtlShipmentCancellation",
        "type": "object"
      },
      "LtlShipmentCancellationApiConfiguration": {
        "description": "Contains fields used to configure the LTL shipment API.",
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "LtlShipmentCancellationApiConfiguration",
        "type": "object"
      },
      "LtlShipmentCancellationConfirmation": {
        "description": "Confirmation of an LTL shipment dispatch cancellation including assigned shipment identifiers of the shipment.",
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipmentIdentifiers": {
            "description": "A list of identifiers for the cancelled shipment. Shipment identifiers provided by the customer may show up here, as well.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "LtlShipmentCancellationConfirmation",
        "type": "object"
      },
      "LtlShipmentIdentifier": {
        "properties": {
          "primaryForType": {
            "description": "Only used in LTL tracking. Whether this is the primary shipment identifier for this type   for the given shipment. The primary shipment identifier for a type will always be attempted before other identifiers of   that type with the capacity provider.",
            "type": "boolean"
          },
          "source": {
            "description": "Only used in LTL tracking. Whether this shipment identifier originated from the customer or the   capacity provider. If the customer has provided this identifier at any point during the shipment's lifetime, this source   will be 'CUSTOMER'. Otherwise, the source will be 'CAPACITY_PROVIDER'. This field is useful for ensuring uniqueness across   your shipment identifiers -- you can't control whether duplicates exist among the capacity-provider-sourced identifiers, but   you can ensure on your end that all of your provided identifiers are unique and query for unique shipments accordingly.",
            "enum": [
              "CUSTOMER",
              "CAPACITY_PROVIDER"
            ],
            "type": "string"
          },
          "type": {
            "description": "The type of the shipment identifier.",
            "enum": [
              "PRO",
              "BILL_OF_LADING",
              "CUSTOMER_REFERENCE",
              "PICKUP",
              "PURCHASE_ORDER",
              "EXTERNAL"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the shipment identifier.",
            "type": "string"
          }
        },
        "title": "LtlShipmentIdentifier",
        "type": "object"
      },
      "LtlShipmentStatus": {
        "properties": {
          "imageReferences": {
            "description": "A list of references to images of documents related to the shipment.",
            "items": {
              "$ref": "#/components/schemas/LtlTrackedShipmentImageReference"
            },
            "type": "array"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity \"INFO\" or \"WARNING\". Note that no messages with severity \"ERROR\" will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "latestStatusUpdate": {
            "$ref": "#/components/schemas/LtlShipmentStatusUpdate"
          },
          "latestStopStatuses": {
            "description": "The most up-to-date statuses of the vehicle in relation to each stop. One and only one status will always be returned for each stop. If the shipment does not have status \"COMPLETED\", this list will always contain one and only one stop status with a code of either \"EN_ROUTE\" or \"ARRIVED\".",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentStopStatus"
            },
            "type": "array"
          },
          "mapUrl": {
            "description": "Publicly accessible URL to the shipment details page.",
            "type": "string"
          },
          "shipment": {
            "$ref": "#/components/schemas/LtlTrackedShipment"
          },
          "statusUpdates": {
            "description": "If requested, all available shipment status updates.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentStatusUpdate"
            },
            "type": "array"
          }
        },
        "title": "LtlShipmentStatus",
        "type": "object"
      },
      "LtlShipmentStatusCollection": {
        "properties": {
          "infoMessages": {
            "description": "Any system messages that occurred processing this request. Severity will be \"INFO\" or \"WARNING\". No messages with severity \"ERROR\" will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipmentStatuses": {
            "description": "A list of shipment statuses that match the query.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentStatus"
            },
            "type": "array"
          }
        },
        "title": "LtlShipmentStatusCollection",
        "type": "object"
      },
      "LtlShipmentStatusReason": {
        "properties": {
          "code": {
            "description": "The reason code for the status of the status update.",
            "enum": [
              "PICKUP_INFO",
              "PICKED_UP",
              "PICKUP_MISSED",
              "INTERLINE_INFO",
              "INTERLINE_MISSED",
              "DEPARTURE_INFO",
              "DEPARTURE_MISSED",
              "HELD",
              "DELAYED",
              "DELIVERY_INFO",
              "DELIVERY_MISSED",
              "DELIVERY_APPOINTMENT",
              "DELIVERED",
              "EXCEPTION",
              "CANCELED",
              "TIMED_OUT",
              "NOT_RECEIVING_DATA_12_TO_23",
              "NOT_RECEIVING_DATA_24_TO_47",
              "NOT_RECEIVING_DATA_48_TO_71",
              "NOT_RECEIVING_DATA_MORE_THAN_72"
            ],
            "type": "string"
          },
          "description": {
            "description": "A description of the reason for the status of the status update. This description may be provided by the capacity provider.",
            "type": "string"
          }
        },
        "title": "LtlShipmentStatusReason",
        "type": "object"
      },
      "LtlShipmentStatusUpdate": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "exceptionDetailCode": {
            "description": "The exception detail code fot the status update. This will provide more granulatiry then the 'exceptionSummaryCode'. This will only be populated when the status update is an exception.",
            "enum": [
              "APPOINTMENT_SET",
              "CANNOT_FIND_CONSIGNEE_ADDRESS",
              "CANNOT_REACH_CONSIGNEE",
              "CONS_CLOSED_FOR_HOLIDAY",
              "CONS_DID_NOT_ORDER_FREIGHT",
              "CONSIGNEE_CANCELED_ORDER",
              "CONSIGNEE_CLOSED",
              "CONSIGNEE_DISPUTES_CHARGES",
              "CREDIT_HOLD",
              "DAMAGED",
              "DAMAGED_ON_DELIVERY",
              "DELIVERY_ATTEMPTED_APPOINTMENT",
              "DELIVERY_ATTEMPTED_NO_DOCK_SPACE",
              "DELIVERY_ATTEMPTED_REAR_LOAD",
              "DELIVERY_REQUIRES_SPECIAL_EQUIPMENT",
              "DELIVERY_SHORTAGE",
              "DUPLICATE_SHIPMENT",
              "EMERGENCY_DELAY_IN_TRANSIT",
              "GENERAL_EXCEPTION",
              "HAZARDOUS_MATERIAL",
              "INCORRECT_ADDRESS_PROVIDED",
              "INVALID_OR_MISSING_PURCHASE_ORDER_NUMBER",
              "LIMITED_ACCESS_LOCATIONS",
              "MISSING_PACKING_LIST",
              "NO_PAYMENT_AVAILABLE_AT_DELIVERY",
              "OVERAGE",
              "PERMANENT_APPOINTMENT_REQUIRED",
              "PROTECTIVE_SERVICE_REQUIRED",
              "RECONSIGNED_TO_NEW_CONSIGNEE",
              "REFUSED_BY_CONS_CANNOT_RECEIVE_ON_DELIVERY_DATE",
              "REFUSED_NO_RETURN_AUTHORIZATION",
              "SHIP_WHEN_CAPACITY_AVAILABLE",
              "SHIPMENT_ALASKA_OR_HAWAII",
              "SHIPMENT_TENDERED_LATE",
              "SHORTAGE",
              "SPOT_MARKET_SHIPMENT",
              "WAITING_INSTRUCTIONS",
              "WEATHER_DELAY",
              "WEATHER_DELAY_CLEARED",
              "WORK_STOPPAGE",
              "WRONG_PRODUCT_SHIPPED"
            ],
            "type": "string"
          },
          "exceptionSummaryCode": {
            "description": "The exception summary code for the status update. This will only be populated when the status update is an exception.",
            "enum": [
              "APPOINTMENT_ISSUE",
              "BILLING_ISSUE",
              "DELIVERY_ISSUE",
              "OTHER_EXCEPTION",
              "PAPERWORK_ISSUE",
              "SHIPMENT_ISSUE",
              "SPOT_SHIPMENT",
              "STAFFING_ISSUE",
              "TRANSIT_ISSUE",
              "VEHICLE_ISSUE",
              "WEATHER_ISSUE"
            ],
            "type": "string"
          },
          "retrievalDateTime": {
            "description": "The date and time that project44 retrieved this status update from the capacity provider, in UTC. Note that this does not represent the time this status was reported by the capacity provider. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "statusCode": {
            "description": "The project44 status code for this status update. This field will always be populated.",
            "enum": [
              "IN_TRANSIT",
              "OUT_TO_STOP",
              "AT_STOP",
              "INFO",
              "COMPLETED"
            ],
            "type": "string"
          },
          "statusReason": {
            "$ref": "#/components/schemas/LtlShipmentStatusReason"
          },
          "stopId": {
            "description": "The id of the shipment stop to which this status update corresponds, if any exists. For example, a status update with the code 'AT_STOP' will typically have this field populated with the stop id the vehicle is at, if specific stop details are avialable from the capacity provider.",
            "format": "int64",
            "type": "integer"
          },
          "stopNumber": {
            "description": "The stop number to which this status update corresponds, if any. For example, a status update with code 'AT_STOP' will typically have this field populated with the stop number the vehicle is at, if specific stop details are avialable from the capacity provider.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of the shipment stop to which this status update corresponds, if any. For example, a status update with code 'AT_STOP' will typically have this field populated with the stop type the vehicle is at, if specific stop details are avialable from the capacity provider.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          },
          "timestamp": {
            "$ref": "#/components/schemas/SplitOffsetDateTime"
          }
        },
        "title": "LtlShipmentStatusUpdate",
        "type": "object"
      },
      "LtlShipmentStopStatus": {
        "properties": {
          "arrivalCode": {
            "description": "The approximate arrival status of the vehicle at the stop, as recorded. The arrival status is relative to the user-defined appointment window for the stop.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "arrivalDateTime": {
            "$ref": "#/components/schemas/SplitOffsetDateTime"
          },
          "arrivalEstimate": {
            "$ref": "#/components/schemas/LtlShipmentArrivalEstimate"
          },
          "departureDateTime": {
            "$ref": "#/components/schemas/SplitOffsetDateTime"
          },
          "statusCode": {
            "description": "The status of the vehicle relative to this stop, whether it is presumed to be currently en route to the stop or whether it has been recorded as having arrived or departed the stop.",
            "enum": [
              "UNKNOWN",
              "EN_ROUTE",
              "ARRIVED",
              "DEPARTED"
            ],
            "type": "string"
          },
          "stopId": {
            "description": "The id of the shipment stop to which this status pertains.",
            "format": "int64",
            "type": "integer"
          },
          "stopNumber": {
            "description": "The number of the shipment stop to which this status pertains.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of the shipment stop to which this status pertains.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          },
          "uuid": {
            "description": "The uuid is used to match shipment stops and created loads.",
            "format": "uuid",
            "type": "string"
          }
        },
        "title": "LtlShipmentStopStatus",
        "type": "object"
      },
      "LtlTrackedShipment": {
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/LtlTrackedShipmentApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "id": {
            "description": "The project44-generated id of the LTL shipment. This may be provided when creating a tracked shipment only if a tracked shipment does not exist with this id but a shipment record does exist in project44's system with this id. This enables linking a dispatched shipment that initially failed to track to its tracking information by passing the id from dispatch. This id will always be returned in the shipment confirmation and may be used in subsequent API calls to reference a shipment.",
            "format": "int64",
            "type": "integer"
          },
          "ltlLegId": {
            "description": "The project44-generated id that is the UUID equivalent of id.  The same rules apply to this value as applies to the id.",
            "format": "uuid",
            "type": "string"
          },
          "masterShipmentId": {
            "description": "The project44-generated id that connects multi-leg shipments agnostic of mode.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentAttributes": {
            "description": "The list of attributes to associate with the shipment.",
            "items": {
              "$ref": "#/components/schemas/Attribute"
            },
            "type": "array"
          },
          "shipmentIdentifiers": {
            "description": "A user-defined list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment with the capacity provider.",
            "items": {
              "$ref": "#/components/schemas/LtlShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "description": "A list of the shipment stops for the shipment. Two and only two stops must be provided -- one of type 'ORIGIN' and one of type 'DESTINATION'. Stops of type 'TERMINAL' may be added as the shipment is tracked and they are discovered via capacity provider information.  Note that 'TERMINAL' will be ignored if provided as part of a PUT.",
            "items": {
              "$ref": "#/components/schemas/LtlTrackedShipmentStop"
            },
            "type": "array"
          }
        },
        "title": "LtlTrackedShipment",
        "type": "object"
      },
      "LtlTrackedShipmentApiConfiguration": {
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to \"TRUE\" and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When false\", an error will be returned if the provided capacity provider account group code is invalid. (default: \"false\")",
            "type": "boolean"
          }
        },
        "title": "LtlTrackedShipmentApiConfiguration",
        "type": "object"
      },
      "LtlTrackedShipmentConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity \"INFO\" or \"WARNING\". No messages with severity \"ERROR\" will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/LtlTrackedShipment"
          }
        },
        "title": "LtlTrackedShipmentConfirmation",
        "type": "object"
      },
      "LtlTrackedShipmentImageReference": {
        "properties": {
          "documentType": {
            "description": "A code for this image's document type.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for this image's format.",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "imageUrl": {
            "description": "The web URL for accessing this image.",
            "type": "string"
          }
        },
        "title": "LtlTrackedShipmentImageReference",
        "type": "object"
      },
      "LtlTrackedShipmentStop": {
        "properties": {
          "additionalAppointmentWindows": {
            "description": "Optional user-defined field in which one or many additional appointment windows can be provided on the stop. Note that the start and end times are required for 'appointmentWindow'; the default start time does not apply to this field. On responses, the time zone identifier (for example, 'America/Chicago') for this date time window is determined by project44 when possible based on the stop's address.",
            "items": {
              "$ref": "#/components/schemas/LtlAdditionalAppointmentWindow"
            },
            "type": "array"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "id": {
            "description": "The id of the stop. This value is read only; it will be ignored on create and update.",
            "format": "int64",
            "type": "integer"
          },
          "involvedParties": {
            "description": "A list of parties and their identifiers related to the shipment stop. These are your customers receiving freight at this stop or your suppliers providing freight from this stop.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "locationIdentifiers": {
            "description": "The identifiers associated with the user-defined stop location, to be used with the Stop Location API.",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifier"
            },
            "type": "array"
          },
          "stopDescription": {
            "description": "Description related to the stop.",
            "type": "string"
          },
          "stopName": {
            "description": "The user-defined or capacity provider-defined name of this stop. This is a freeform field. Project44 will default the name of each stop based on the stop number and type if no other name is available.",
            "type": "string"
          },
          "stopNumber": {
            "description": "The stop number, where \"1'\" is the origin, and the destination has the largest number, with any stops in between ordered by appointment time. This field may not be provided when creating a shipment. The destination stop number will change dynamically as terminals are discovered along the shipment's route from origin to destination. Thus, the stop type is most useful for easily and reliably identifying the origin and destination.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of this stop. The user-defined stops will always have the type of 'ORIGIN' and 'DESTINATION', which are customer locations. Stops of the type 'TERMINAL', which are capacity provider redistribution centers, may be inserted dynamically as they are returned by the capacity provider.  Note that 'TERMINAL' will be ignored if provided as part of a PUT.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          },
          "uuid": {
            "description": "UUID that uniquely identifies a stop. This value is generated by project44 on a successful PUT or POST.",
            "format": "uuid",
            "type": "string"
          }
        },
        "title": "LtlTrackedShipmentStop",
        "type": "object"
      },
      "MarkDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "pieces": {
            "type": "integer",
            "description": "Number of pieces in a shipment requiring marking or tagging."
          }
        }
      },
      "MarketQuote": {
        "required": [],
        "type": "object",
        "properties": {
          "capacityProviderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
              }
            ],
            "description": "Reference to the desired carrier to request a quote from for the related shipment."
          },
          "capacityProviderName": {
            "type": "string",
            "description": "The name of the capacity provider's company."
          },
          "carrierMetrics": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CarrierMetrics"
              }
            ],
            "description": "Carrier metrics data from LMS containing performance metrics."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this quote was created. This value is read only.",
            "format": "date-time"
          },
          "deliveryDate": {
            "type": "string",
            "description": "Expected delivery date and time of the shipment.",
            "format": "date"
          },
          "expirationDateTime": {
            "type": "string",
            "description": "Quote expiration time set by the carrier.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "Project44-generated identifier for the quote.",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this quote was last modified. This value is read only.",
            "format": "date-time"
          },
          "pickupDate": {
            "type": "string",
            "description": "Expected pickup date and time of the shipment.",
            "format": "date"
          },
          "respondByDateTime": {
            "type": "string",
            "description": "Rate request expiration time that is set by the shipper.",
            "format": "date-time"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuoteStatus"
              }
            ],
            "description": "Current status of the quote."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuoteType"
              }
            ],
            "description": "Initiation type of the quote."
          },
          "totalRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Total rate for the requested shipment."
          },
          "transportationMode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TransportationMode"
              }
            ],
            "description": "Transportation mode used to request the quote from a capacity provider.",
            "default": "TRUCKLOAD"
          }
        },
        "description": "The minimal version of quote dto. Only contains quote related data"
      },
      "MegaType": {
        "properties": {
          "description": {
            "type": "string",
            "maxLength": 50,
            "description": "Free text space to describe the requirements for MEGA trailer type."
          }
        },
        "type": "object",
        "required": []
      },
      "Message": {
        "description": "Simple representation of an info, warning, or error message.",
        "properties": {
          "diagnostic": {
            "description": "Diagnostic information, often originating from the capacity provider.",
            "type": "string"
          },
          "message": {
            "description": "Message informational text.",
            "type": "string"
          },
          "severity": {
            "description": "The severity of this message.",
            "enum": [
              "ERROR",
              "WARNING",
              "INFO"
            ],
            "type": "string"
          },
          "source": {
            "description": "The originator of this message -- either project44 (the system) or the capacity provider.",
            "enum": [
              "SYSTEM",
              "CAPACITY_PROVIDER"
            ],
            "type": "string"
          }
        },
        "title": "Message",
        "type": "object"
      },
      "MessageStatus": {
        "enum": [
          "PASS",
          "FAIL",
          "WARNING"
        ],
        "type": "string",
        "description": "Indicate if the request was successful and if there were exceptions"
      },
      "MessageStatusInformation": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code related to the information."
          },
          "message": {
            "type": "string",
            "description": "Message related to the information."
          },
          "type": {
            "type": "string",
            "description": "Type of information related to the message status."
          }
        }
      },
      "Milestones": {
        "type": "object",
        "properties": {
          "actualDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Actual date and time when the milestone occurred",
            "example": "2024-01-15T10:30:00Z"
          },
          "event": {
            "type": "string",
            "enum": [
              "ARRIVED",
              "START",
              "END",
              "DEPARTED",
              "CHECKED_IN",
              "CHECKED_OUT"
            ],
            "description": "Type of milestone event",
            "example": "ARRIVED"
          },
          "scheduledDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Scheduled date and time for the milestone",
            "example": "2024-01-15T10:00:00Z"
          }
        }
      },
      "MilestonesSchema": {
        "type": "object",
        "required": [],
        "properties": {
          "milestones": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [],
              "properties": {
                "event": {
                  "type": "string",
                  "enum": [
                    "ARRIVED",
                    "START",
                    "END",
                    "DEPARTED",
                    "CHECKED_IN",
                    "CHECKED_OUT"
                  ],
                  "description": "Type of milestone event",
                  "example": "ARRIVED"
                },
                "scheduledDateTime": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Scheduled date and time for the milestone",
                  "example": "2024-01-15T10:00:00Z"
                },
                "actualDateTime": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Actual date and time when the milestone occurred",
                  "example": "2024-01-15T10:30:00Z"
                }
              }
            }
          }
        }
      },
      "MobileTrackingEventDetails": {
        "description": "Details of an event related to a mobile tracking",
        "properties": {
          "code": {
            "description": "${MobileTrackingEventDetails.apiModel.code.value}",
            "enum": [
              "UNKNOWN",
              "DRIVER_ACCEPTED_TERMS_AND_CONDITIONS",
              "DRIVER_INITIATED_APP_SIGNUP",
              "DRIVER_LOADED_ASSIGNED_SHIPMENT_IN_APP",
              "DRIVER_DELETED_ACCOUNT",
              "DRIVER_CLAIMED_SHIPMENT",
              "SHIPMENT_ASSIGNED_INVALID_PHONE_NUMBER",
              "DRIVER_OPENED_INVITATION_LINK",
              "DRIVER_ENTERED_INVALID_VERIFICATION_CODE",
              "DRIVER_CONFIRMED_PHONE_NUMBER",
              "DRIVER_COMPLETED_SHIPMENT_MANUALLY",
              "DRIVER_REJECTED_SHIPMENT_MANUALLY",
              "DRIVER_COMPLETED_SETUP",
              "DRIVER_PROVIDED_INSUFFICIENT_LOCATION_PERMISSION",
              "SHIPMENT_ASSIGNED_VOIP_NUMBER"
            ],
            "type": "string"
          }
        },
        "title": "MobileTrackingEventDetails",
        "type": "object"
      },
      "MonetaryValue": {
        "required": [],
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "description": "The value of the shipment"
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          }
        },
        "description": "A monetary value expressing amount and currency type."
      },
      "MonetaryValueRangeFilter": {
        "properties": {
          "maximumValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "maximumValueInclusive": {
            "description": "Signifies if the maximum value is inclusive. (default: false )",
            "type": "boolean"
          },
          "minimumValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "minimumValueInclusive": {
            "description": "Signifies if the minimum value is inclusive. (default: true )",
            "type": "boolean"
          }
        },
        "title": "MonetaryValueRangeFilter",
        "type": "object"
      },
      "MonthlyCarrierPerformance": {
        "properties": {
          "deliveryScheduleReliability": {
            "description": "Percentage of tracked shipments in the month that were delivered within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "month": {
            "description": "The month (1-12) the enclosed performance data was collected",
            "format": "int32",
            "type": "integer"
          },
          "percentTracked": {
            "description": "Percentage of shipments in the month where tracking was initiated which received at least one tracking update",
            "format": "int32",
            "type": "integer"
          },
          "pickupScheduleReliability": {
            "description": "Percentage of tracked shipments in the month that were picked up within 2 hours of the scheduled time",
            "format": "int32",
            "type": "integer"
          },
          "shipmentVolume": {
            "description": "Number of shipments tracked in the month",
            "enum": [
              "VOLUME_0_TO_10_SHIPMENTS",
              "VOLUME_11_TO_50_SHIPMENTS",
              "VOLUME_51_TO_100_SHIPMENTS",
              "VOLUME_101_OR_MORE_SHIPMENTS"
            ],
            "type": "string"
          },
          "year": {
            "description": "The year of the month the performance data was collected",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "MonthlyCarrierPerformance",
        "type": "object"
      },
      "multi_modal_booking_service_public__shipping_details__ocean__ContainerType": {
        "type": "string",
        "enum": [
          "TWENTY_FOOT",
          "FORTY_FOOT",
          "FORTY_FOOT_HIGH_CUBE",
          "FORTY_FOOT_OPEN_TOP",
          "FORTYFIVE_FOOT_HIGH_CUBE",
          "REEFER_TWENTY_FOOT",
          "REEFER_FORTY_FOOT",
          "REEFER_FORTY_FOOT_HIGH_CUBE"
        ],
        "description": "An enumeration."
      },
      "multi_modal_booking_service_public__shipping_details__truckload__ContainerType": {
        "properties": {
          "containers": {
            "items": {
              "$ref": "#/components/schemas/multi_modal_booking_service_public__shipping_details__ocean__ContainerType"
            },
            "type": "array",
            "maxItems": 2,
            "minItems": 1,
            "description": "Containers to be transported on the trailer. Minimum of one, maximum of two 20 ft containers."
          }
        },
        "type": "object",
        "required": []
      },
      "MultiModalImageQuery": {
        "description": "Request an image of a document related to a shipment. This is the same model name as v2/v3, but with slightly different fields. This should be used with the multi-modal imaging endpoint only.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/ImageApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "destinationAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "documentType": {
            "description": "A code for the requested image's document type.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for the format of the image to be returned. The capacity provider's image will be converted to this format. (default: 'PNG')",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "mode": {
            "description": "The transportation mode of the shipment for which images should be retrieved. Only LTL images are supported currently.",
            "enum": [
              "PARCEL",
              "LTL",
              "VOLUME_LTL",
              "TRUCKLOAD",
              "OCEAN",
              "RAIL"
            ],
            "type": "string"
          },
          "pickupDate": {
            "description": "The date this shipment was picked up by carrier. Some carriers require this to aid in retrieving documents. (format: yyyy-MM-dd)",
            "format": "date",
            "type": "string"
          },
          "shipmentIdentifiers": {
            "description": "A list of identifiers or reference numbers for this shipment. 'PRO' is the only currently supported identifier type and exactly one value of this type must be provided.",
            "items": {
              "$ref": "#/components/schemas/ShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "MultiModalImageQuery",
        "type": "object"
      },
      "MultiModalImageReference": {
        "description": "Reference to an image of a document related to a shipment.",
        "properties": {
          "documentType": {
            "description": "A code for this image's document type, matching what was requested.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for this image's format, matching what was requested.",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "imageUrl": {
            "description": "The web URL for accessing this image.",
            "type": "string"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          }
        },
        "title": "MultiModalImageReference",
        "type": "object"
      },
      "NameWrapper": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "$ref": "#/components/schemas/Operator"
          },
          "value": {
            "type": "string",
            "description": "The name of the document to search for"
          }
        }
      },
      "NmfcCode": {
        "description": "An object that represents the NMFC item code and sub code associated with the shipment contents",
        "properties": {
          "code": {
            "description": "NMFC item and sub code. Codes can only contain numeric characters and the '-' character. The item code must be 4 to 6 digits long. The '-' and sub code are optional, but if sub code is included it is 1 to 2 digits long. Must be in format XXXXXX-XX.",
            "type": "string"
          }
        },
        "title": "NmfcCode",
        "type": "object"
      },
      "NonSpecificAccessorials": {
        "enum": [
          "EXPEDITE",
          "EXPEDITE17",
          "EXPEDITEAM",
          "GURWIN",
          "GSSING",
          "GSMUL",
          "GSFM",
          "GS8",
          "GS9",
          "GS10",
          "GS11",
          "GSAM",
          "GS14",
          "GS15",
          "GS1530",
          "GUR",
          "ACCELERATED",
          "CAPLOAD",
          "CNTER20",
          "CNTER40",
          "CNTER40H",
          "CNTER45",
          "CNTER53",
          "CAPLOADTRA",
          "CAPLOADPUP",
          "CHASSIS",
          "FLTTRCK",
          "TANK",
          "OPENTOP",
          "STRAIGHT",
          "HOLIWEEK",
          "WESER",
          "AFTRHR",
          "CHNGBOL",
          "CORBOL",
          "REEFER",
          "FRIDGE",
          "PFH",
          "MAINTEMP",
          "HEAT",
          "PFZ",
          "PFZC",
          "PROTECT",
          "PROTECTDRM",
          "PROTECTPAL",
          "FRZABLE",
          "HAZM",
          "POISON",
          "LOAD",
          "LOADCNT",
          "LOADUNLOAD",
          "DRASST",
          "UNPCK",
          "UNLOAD",
          "UNLOADCNT",
          "O750U6",
          "OVDIM",
          "OVERWGHT",
          "REG",
          "INT",
          "IREG",
          "BYDIND",
          "TSAC",
          "HMLAND",
          "SECINS",
          "ADVCOL",
          "CONSOL",
          "DESCINS",
          "DLYCHRG",
          "INBND",
          "RMVDEB",
          "TARP",
          "TCKNU",
          "PRMIT",
          "WINSPC",
          "WVERI",
          "XTRLBR",
          "AIR",
          "AIRBAG",
          "BAGLINER",
          "BOBTAIL",
          "CRANE",
          "CROSS",
          "DROPPULL",
          "FORK",
          "LABEL",
          "LIQUOR",
          "PALLET",
          "SIGN",
          "SPECIALEQUIP",
          "ARCHR",
          "BLIND",
          "BOND",
          "BULKHEAD",
          "CANFEE",
          "COD",
          "CREDEL",
          "DET",
          "DRAY",
          "DRYRU",
          "EV",
          "EXPORT",
          "FOOD",
          "HAWAII",
          "HOMEMOVE",
          "HIGHDOCK",
          "IMPORT",
          "LUMPER",
          "LYOVR",
          "MARKING",
          "OILSANDS",
          "RECON",
          "SEADOC",
          "SINGSHIP",
          "STORAGE",
          "STPOFF",
          "TMCHG",
          "WHITEGLOVE"
        ],
        "description": "An enumeration."
      },
      "Notification": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email address of contact for updates about shipment movements.",
            "format": "email"
          },
          "phoneNumber": {
            "type": "string",
            "description": "Phone number of contact for updates about shipment movements."
          }
        }
      },
      "OAuth2Error": {
        "type": "object",
        "description": "Standard OAuth 2.0 error model.",
        "properties": {
          "error": {
            "type": "string",
            "description": "The type of error that has occurred.",
            "enum": [
              "invalid_request",
              "invalid_client",
              "invalid_grant",
              "unauthorized_client",
              "unsupported_grant_type",
              "invalid_scope",
              "access_denied",
              "unsupported_response_type",
              "server_error",
              "temporarily_unavailable"
            ]
          },
          "error_description": {
            "type": "string",
            "description": "A detailed description of the error."
          },
          "support_reference_id": {
            "type": "string",
            "description": "A reference identifier used by project44 support to assist with certain error messages."
          }
        },
        "required": []
      },
      "OAuth2Token": {
        "type": "object",
        "description": "Standard OAuth 2.0 model for returning an access token.",
        "properties": {
          "access_token": {
            "type": "string",
            "description": "The project44 access token, which can be passed as a bearer token to all other project44 endpoints to have your client application's requests authorized. Pass the \"Authorization\" HTTP header to other endpoints in this form: \"Authorization: Bearer {access_token}\". Your client application can be granted roles and permissions via the project44 user management UI under user \"app-{client_id}@client-applications.project44.com\"."
          },
          "expires_in": {
            "type": "integer",
            "format": "int64",
            "description": "The time in seconds for which the access token will be valid before expiring. Tokens currently last approximately 12 hours, but this is subject to change by project44 in the future. Tokens should be reused by your application to the fullest extent possible for performance and security reasons by storing the token in a secure cache. Instead of using this expiration time to know when to generate a new access token, simply make requests with the token until project44 responds with a \"401 Unauthorized\" HTTP status code, at which point your application should generate and cache a new one."
          },
          "token_type": {
            "type": "string",
            "description": "The type of access token returned. This will always be type \"BEARER\".",
            "enum": [
              "BEARER"
            ]
          }
        }
      },
      "OceanAttribute": {
        "properties": {
          "name": {
            "description": "The key (name) for the custom attribute. Must be unique.",
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "values": {
            "description": "The values for the custom attribute.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OceanAttribute",
        "type": "object"
      },
      "OceanBookingResponseDetails": {
        "type": "object",
        "properties": {
          "cutOffDetails": {
            "$ref": "#/components/schemas/CutOffDetails"
          },
          "containerDetails": {
            "items": {
              "$ref": "#/components/schemas/ContainerDetails"
            },
            "type": "array",
            "description": "List of container details related to the booking, composed of container ID, reference keys, etc."
          },
          "estimatedFinalDestinationDatetime": {
            "type": "string",
            "description": "Estimated time for goods to arrive to destination",
            "format": "date-time"
          },
          "portsDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortDetails"
            },
            "description": "List of ports and arrival dates"
          }
        }
      },
      "OceanBookingType": {
        "enum": [
          "LESS_THAN_CONTAINER_LOAD",
          "FULL_CONTAINER_LOAD",
          "ROLL_ON_ROLL_OFF",
          "OUT_OF_GAUGE"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "OceanBookingUpdateDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "numberOfPreviousOceanBookings": {
            "type": "integer",
            "format": "int32"
          },
          "previousOceanBookings": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PreviousOceanBooking"
            }
          }
        }
      },
      "OceanDetails": {
        "properties": {
          "accessorials": {
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "type": "array",
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "bookingType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanBookingType"
              }
            ],
            "description": "The type of sea freight to be handled; the container-fill volume, or lack thereof."
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo. \nRequired when booking `ROLL_ON_ROLL_OFF` and `LESS_THAN_CONTAINER_LOAD`."
          },
          "containerCount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FullContainerLoadContainerCount"
              },
              {
                "$ref": "#/components/schemas/OutOfGaugeContainerCount"
              }
            ],
            "description": "Number of equipment requested for a booking needs to be provided here. Only required when booking `FULL_CONTAINER_LOAD` or `OUT_OF_GAUGE`."
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array",
            "description": "Individual shipper-represented groups which are involved with the shipment."
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or boat-inaccessible yards."
          }
        },
        "type": "object",
        "required": []
      },
      "OceanEquipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the identifier.",
            "enum": [
              "CONTAINER_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the identifier.",
            "type": "string"
          }
        },
        "title": "OceanEquipmentIdentifier",
        "type": "object"
      },
      "OceanEvent": {
        "properties": {
          "eventCode": {
            "description": "The code describing this event.",
            "enum": [
              "TRACKING_STARTED",
              "TRACKING_STOPPED",
              "UNKNOWN",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT",
              "LOADED",
              "EMBARKED",
              "BERTHING",
              "ARRIVED",
              "DISCHARGED",
              "DEPARTED_TERMINAL",
              "BECAME_AVAILABLE",
              "CUSTOMS_HOLD_INITIATED",
              "LINE_HOLD_INITIATED",
              "OTHER_HOLD_INITIATED",
              "CUSTOMS_HOLD_RELEASED",
              "LINE_HOLD_RELEASED",
              "OTHER_HOLD_RELEASED"
            ],
            "type": "string"
          },
          "stopNumber": {
            "description": "The number of the stop from the stop array where this state occurred, if applicable.",
            "format": "int32",
            "type": "integer"
          },
          "timeStamp": {
            "description": "The date and time when this event occurred. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500).",
            "type": "string"
          },
          "vesselNumber": {
            "description": "The number of the vessel from the vessel array where this state occurred, if applicable.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "OceanEvent",
        "type": "object"
      },
      "OceanEventDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "${OceanEventDetails.apiModel.code.value}",
            "enum": [
              "UNKNOWN",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL",
              "BOOKING_CONFIRMED_BY_FFW",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER",
              "BOOKING_CANCELLED",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN",
              "ARRIVAL_AT_EXPORT_WAREHOUSE",
              "PICKED_UP_AT_ORIGIN",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE",
              "ARRIVAL_AT_ORIGIN_CFS",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING",
              "EXPORT_CUSTOMS_DOCS_FILING",
              "EXPORT_CUSTOMS_HOLD",
              "EXPORT_CUSTOMS_CLEARANCE",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE",
              "IMPORT_CUSTOMS_DOCS_FILING",
              "IMPORT_CUSTOMS_HOLD",
              "IMPORT_CUSTOMS_CLEARANCE",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE",
              "ARRIVAL_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "DEPARTURE_OF_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "ARRIVAL_AT_DESTINATION_CFS",
              "STRIP_AT_DESTINATION_CFS",
              "DEPARTURE_FROM_DESTINATION_CFS",
              "ARRIVAL_AT_IMPORT_WAREHOUSE",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE",
              "PROOF_OF_DELIVERY",
              "GATE_OUT_EMPTY_CONTAINER_AT_DESTINATION",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE",
              "HANDOVER_TO_THIRD_PARTY",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL",
              "CONTAINER_ROLLED_AT_PORT_OF_LOADING",
              "CONTAINER_ROLLED_AT_TRANSSHIPMENT_PORT",
              "CONSIGNEE_NOTIFY",
              "EXPORT_HOLD",
              "EXPORT_AVAILABLE",
              "IMPORT_HOLD",
              "IMPORT_AVAILABLE",
              "PENDING_UPDATE",
              "SCHEDULED",
              "READY_FOR_PICK_UP_AT_ORIGIN",
              "ARRIVAL_AT_ORIGIN_CFS_OR_WAREHOUSE",
              "LOAD_AT_ORIGIN_CFS_OR_WAREHOUSE",
              "DEPARTURE_FROM_ORIGIN_CFS_OR_WAREHOUSE",
              "ARRIVAL_AT_INLAND_EXPORT_TERMINAL",
              "DISCHARGE_AT_INLAND_EXPORT_TERMINAL",
              "LOAD_AT_INLAND_EXPORT_TERMINAL",
              "DEPARTURE_FROM_INLAND_EXPORT_TERMINAL",
              "GATE_IN_FULL_AT_PORT_OF_LOADING",
              "LOAD_ONTO_VESSEL_AT_PORT_OF_LOADING",
              "DISCHARGE_FROM_VESSEL_AT_TRANSSHIPMENT_PORT",
              "LOAD_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT",
              "DISCHARGE_FROM_VESSEL_AT_PORT_OF_DISCHARGE",
              "GATE_OUT_FULL_AT_PORT_OF_DISCHARGE",
              "ARRIVAL_AT_INLAND_IMPORT_TERMINAL",
              "DISCHARGE_AT_INLAND_IMPORT_TERMINAL",
              "LOAD_AT_INLAND_IMPORT_TERMINAL",
              "DEPARTURE_FROM_INLAND_IMPORT_TERMINAL",
              "ARRIVAL_AT_DESTINATION_CFS_OR_WAREHOUSE",
              "STRIP_AT_DESTINATION_CFS_OR_WAREHOUSE",
              "DEPARTURE_FROM_DESTINATION_CFS_OR_WAREHOUSE"
            ]
          }
        },
        "description": "${OceanEventDetails.apiModel.class.value}"
      },
      "OceanPosition": {
        "properties": {
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "timeStamp": {
            "description": "The date and time at which this position data was recorded. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500).",
            "type": "string"
          },
          "vesselNumber": {
            "description": "The number of the vessel from the vessel array which was carrying the container at this position.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "OceanPosition",
        "type": "object"
      },
      "OceanServiceType": {
        "enum": [
          "CONTAINER_YARD_TO_CONTAINER_YARD",
          "CONTAINER_YARD_TO_DOOR",
          "DOOR_TO_CONTAINER_YARD",
          "DOOR_TO_DOOR"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "OceanShipment": {
        "properties": {
          "attributes": {
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanAttribute"
            },
            "type": "array"
          },
          "carrierSCACCode": {
            "description": "The SCAC code identifying the carrier transporting the given container. This field is required.",
            "type": "string"
          },
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/OceanEquipmentIdentifier"
          },
          "masterShipmentId": {
            "description": "This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this ocean leg to the overall master shipment. Otherwise pass any valid new UUID to create a new shipment. If no masterShipmentId is passed on POST request a new UUID will be generated. This value will always be returned on all responses.",
            "format": "uuid",
            "type": "string"
          },
          "oceanLegId": {
            "description": "The project44-generated id for the ocean shipment. This id may be used in subsequent API calls to reference a shipment.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentId": {
            "description": "DEPRECATED: The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use masterShipmentId instead.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentIdentifiers": {
            "description": "A list of optional identifiers to associate with this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "OceanShipment",
        "type": "object"
      },
      "OceanShipmentConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/OceanShipment"
          }
        },
        "title": "OceanShipmentConfirmation",
        "type": "object"
      },
      "OceanShipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the identifier.",
            "enum": [
              "BILL_OF_LADING",
              "BOOKING_NUMBER"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the identifier.",
            "type": "string"
          }
        },
        "title": "OceanShipmentIdentifier",
        "type": "object"
      },
      "OceanShippingDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "bookingType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanBookingType"
              }
            ],
            "description": "The type of sea freight to be handled; the container-fill volume, or lack thereof."
          },
          "cargoMeasurements": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CargoMeasurements"
              }
            ],
            "description": "Volume, weight and linear dimensions of the cargo. \nRequired when booking `ROLL_ON_ROLL_OFF` and `LESS_THAN_CONTAINER_LOAD`."
          },
          "containerCount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FullContainerLoadContainerCount"
              },
              {
                "$ref": "#/components/schemas/OutOfGaugeContainerCount"
              }
            ],
            "description": "Number of equipment requested for a booking needs to be provided here. Only required when booking `FULL_CONTAINER_LOAD` or `OUT_OF_GAUGE`."
          },
          "cutOffDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CutOffDetails"
              }
            ],
            "description": "..."
          },
          "containerDetails": {
            "items": {
              "$ref": "#/components/schemas/ContainerDetails"
            },
            "type": "array",
            "description": "List of container details related to the booking, composed of container ID, reference keys, etc."
          },
          "estimatedFinalDestinationDatetime": {
            "type": "string",
            "description": "Estimated time for goods to arrive to destination",
            "format": "date-time"
          },
          "incoterm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncotermType"
              }
            ],
            "description": "International Commercial Terms for shipment responsibilities, according to the [ICC](https://iccwbo.org/)."
          },
          "parties": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingParty"
            },
            "description": "Individual shipper-represented groups which are involved with the shipment on this"
          },
          "portsDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortDetails"
            },
            "description": "List of ports and arrival dates"
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanServiceType"
              }
            ],
            "description": "The type of service requested for booking. In other words, is the Carrier expected to handle the shipment between ports or boat-inaccessible yards."
          }
        }
      },
      "OceanState": {
        "properties": {
          "endTime": {
            "description": "The date and time when the container left this state. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500).",
            "type": "string"
          },
          "startTime": {
            "description": "The date and time when the container entered this state. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500).",
            "type": "string"
          },
          "stateCode": {
            "description": "The code describing this state.",
            "enum": [
              "AT_STOP",
              "IN_TRANSIT",
              "ON_WATER",
              "LINE_HOLD",
              "CUSTOMS_HOLD",
              "OTHER_HOLD",
              "AT_TERMINAL",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "stopNumber": {
            "description": "The number of the stop from the stop array where this state occurred, if applicable.",
            "format": "int32",
            "type": "integer"
          },
          "vesselNumber": {
            "description": "The number of the vessel from the vessel array where this state occurred, if applicable.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "OceanState",
        "type": "object"
      },
      "OceanStop": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "arrivalTiming": {
            "$ref": "#/components/schemas/Timing"
          },
          "departureTiming": {
            "$ref": "#/components/schemas/Timing"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "id": {
            "description": "The id of this stop.",
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "description": "The name of this port.",
            "type": "string"
          },
          "portCBPCode": {
            "description": "The Customs and Border Protection code of this port.",
            "type": "string"
          },
          "portLocode": {
            "description": "The UN/LOCODE of this port. 2 char country code + 3 char location code.",
            "type": "string"
          },
          "stopNumber": {
            "description": "The project44-assigned number for this stop.  The stop is referenced by this number in the lists of events and states.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of the stop.",
            "enum": [
              "PLACE_OF_ORIGIN",
              "PORT_OF_ORIGIN",
              "PORT_OF_LOADING",
              "TRANSSHIPMENT_PORT",
              "PORT_OF_DISCHARGE",
              "DESTINATION"
            ],
            "type": "string"
          }
        },
        "title": "OceanStop",
        "type": "object"
      },
      "OceanTrackedContainer": {
        "properties": {
          "containerId": {
            "description": "The ISO 6346 compliant number of this container.",
            "type": "string"
          },
          "currency": {
            "description": "The currency in which the demurrage value is represented.",
            "enum": [
              "USD",
              "CAD",
              "MXN",
              "EUR"
            ],
            "type": "string"
          },
          "demurrage": {
            "description": "The total reported demurrage charge. This field is set by project44 in the API response.",
            "type": "number"
          },
          "lastFreeDay": {
            "description": "The last day of free storage in which a container can be picked up without paying demurrage. This field is set by project44 in the API response. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T00:00:00+0000).",
            "type": "string"
          }
        },
        "title": "OceanTrackedContainer",
        "type": "object"
      },
      "OceanTrackedShipment": {
        "properties": {
          "attributes": {
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanAttribute"
            },
            "type": "array"
          },
          "carrierSCACCode": {
            "description": "The SCAC code identifying the carrier transporting the given container. This field is required.",
            "type": "string"
          },
          "containerDetails": {
            "$ref": "#/components/schemas/OceanTrackedContainer"
          },
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/OceanEquipmentIdentifier"
          },
          "events": {
            "description": "A list of container events in chronological order, with possible references to the stop and vessel where they occurred.",
            "items": {
              "$ref": "#/components/schemas/OceanEvent"
            },
            "type": "array"
          },
          "mapUrl": {
            "description": "Public link to view the shipment in the VOC.",
            "type": "string"
          },
          "masterShipmentId": {
            "description": "This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this ocean leg to the overall master shipment. Otherwise pass any valid new UUID to create a new shipment. If no masterShipmentId is passed on POST request a new UUID will be generated. This value will always be returned on all responses.",
            "format": "uuid",
            "type": "string"
          },
          "oceanLegId": {
            "description": "The project44-generated id for the ocean shipment. This id may be used in subsequent API calls to reference a shipment.",
            "format": "uuid",
            "type": "string"
          },
          "positions": {
            "description": "A list of geoCoordinates and timestamps describing the container's location on the water, with reference to the vessel which carried it.",
            "items": {
              "$ref": "#/components/schemas/OceanPosition"
            },
            "type": "array"
          },
          "shipmentId": {
            "description": "DEPRECATED: The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use masterShipmentId instead.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentIdentifiers": {
            "description": "A list of optional identifiers to associate with this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanShipmentIdentifier"
            },
            "type": "array"
          },
          "states": {
            "description": "A list of container states in chronological order, with possible references to the stop and vessel where they occurred.",
            "items": {
              "$ref": "#/components/schemas/OceanState"
            },
            "type": "array"
          },
          "stops": {
            "description": "The list of stops (origin port, destination port, or transhipment ports) in this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanStop"
            },
            "type": "array"
          },
          "vessels": {
            "description": "A list of vessels being tracked within this shipment.",
            "items": {
              "$ref": "#/components/schemas/OceanVessel"
            },
            "type": "array"
          }
        },
        "title": "OceanTrackedShipment",
        "type": "object"
      },
      "OceanTrackedShipmentConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "trackedShipment": {
            "$ref": "#/components/schemas/OceanTrackedShipment"
          }
        },
        "title": "OceanTrackedShipmentConfirmation",
        "type": "object"
      },
      "OceanVessel": {
        "properties": {
          "callSign": {
            "description": "The alphanumeric value that uniquely identifies the vessel being tracked. This field is set by project44 in the API response.",
            "type": "string"
          },
          "draught": {
            "description": "The draught of the vessel being tracked. This determines the minimum depth of water the vessel can safely navigate. This field is set by project44 in the API response.",
            "type": "number"
          },
          "imo": {
            "description": "The IMO (International Maritime Organization) number representing the vessel being tracked.",
            "format": "int64",
            "type": "integer"
          },
          "length": {
            "description": "The length of the vessel being tracked. This field is set by project44 in the API response.",
            "type": "number"
          },
          "lengthUnit": {
            "description": "The unit of measure for length, width, and draught.",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "mmsi": {
            "description": "The MMSI (Maritime Mobile Service Identity) value that uniquely identifies the vessel being tracked. This field is set by project44 in the API response.",
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "description": "The name of the vessel being tracked. This field is set by project44 in the API response.",
            "type": "string"
          },
          "shipType": {
            "description": "The type of the vessel being tracked. This field is set by project44 in the API response.",
            "type": "string"
          },
          "vesselNumber": {
            "description": "The project44-assigned number for this vessel. The vessel is referenced by this number in the lists of events, states and positions.",
            "format": "int32",
            "type": "integer"
          },
          "width": {
            "description": "The width of the vessel being tracked. This field is set by project44 in the API response.",
            "type": "number"
          }
        },
        "title": "OceanVessel",
        "type": "object"
      },
      "OffsetDateTimeRangeFilter": {
        "description": "A date and time range filter, with time zone offset.",
        "properties": {
          "endDateTime": {
            "description": "End Date time of this range with timezone offset. (format: 'yyyy-MM-dd'T'HH:mm:ssZ' )",
            "type": "string"
          },
          "endDateTimeInclusive": {
            "description": "Signifies if the end date time is inclusive. (default: false)",
            "type": "boolean"
          },
          "startDateTime": {
            "description": "Start Date time of this range with timezone offset. (format: 'yyyy-MM-dd'T'HH:mm:ssZ' )",
            "type": "string"
          },
          "startDateTimeInclusive": {
            "description": "Signifies if the start date time is inclusive. (default: true)",
            "type": "boolean"
          }
        },
        "title": "OffsetDateTimeRangeFilter",
        "type": "object"
      },
      "OffsetDateTimeWindow": {
        "description": "A date and time range, with time zone offset.",
        "properties": {
          "endDateTime": {
            "description": "End time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "startDateTime": {
            "description": "Start time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          }
        },
        "title": "OffsetDateTimeWindow",
        "type": "object"
      },
      "OpeningHours": {
        "properties": {
          "appliesFriday": {
            "description": "Whether this set of OpeningHours applies on Fridays.",
            "type": "boolean"
          },
          "appliesMonday": {
            "description": "Whether this set of OpeningHours applies on Mondays.",
            "type": "boolean"
          },
          "appliesSaturday": {
            "description": "Whether this set of OpeningHours applies on Saturdays.",
            "type": "boolean"
          },
          "appliesSunday": {
            "description": "Whether this set of OpeningHours applies on Sundays.",
            "type": "boolean"
          },
          "appliesThursday": {
            "description": "Whether this set of OpeningHours applies on Thursdays.",
            "type": "boolean"
          },
          "appliesTuesday": {
            "description": "Whether this set of OpeningHours applies on Tuesdays.",
            "type": "boolean"
          },
          "appliesWednesday": {
            "description": "Whether this set of OpeningHours applies on Wednesdays.",
            "type": "boolean"
          },
          "closes": {
            "description": "Local closing time of this location, formatted as HH:mm.",
            "type": "string"
          },
          "opens": {
            "description": "Local opening time of this location, formatted as HH:mm.",
            "type": "string"
          }
        },
        "required": [],
        "title": "OpeningHours",
        "type": "object"
      },
      "Operator": {
        "enum": [
          "EQUALS",
          "NOT_EQUALS",
          "CONTAINS"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "OrderArrivalStatus": {
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/TimelinessCode"
          },
          "durationInMinutes": {
            "type": "integer",
            "format": "int64"
          }
        },
        "description": "Comparison between the planned date and time window and the date and time when the order is predicted to be delivered."
      },
      "OrderCustomAttribute": {
        "properties": {
          "name": {
            "description": "The key (name) for the custom attribute. Must be unique (case-insensitive).",
            "type": "string"
          },
          "values": {
            "description": "The values for the custom attribute.",
            "items": {
              "type": "string"
            },
            "maxItems": 250,
            "minItems": 1,
            "type": "array"
          }
        },
        "title": "OrderCustomAttribute",
        "type": "object"
      },
      "OrderDurationRange": {
        "description": "Match orders on the duration of the order arrival status.",
        "properties": {
          "fromDuration": {
            "$ref": "#/components/schemas/TimeDuration"
          },
          "fromInclusive": {
            "description": "Signifies if the minimum value is inclusive. (default: true)",
            "type": "boolean"
          },
          "toDuration": {
            "$ref": "#/components/schemas/TimeDuration"
          },
          "toInclusive": {
            "description": "Signifies if the maximum value is inclusive. (default: false)",
            "type": "boolean"
          }
        },
        "title": "OrderDurationRange",
        "type": "object"
      },
      "OrderHealthCriteria": {
        "description": "To match orders based on derivedOrderHealth: arrival status, duration range / delta, target date range for estimated time of arrival.",
        "properties": {
          "dateRanges": {
            "items": {
              "$ref": "#/components/schemas/OrderHealthDateCriteria"
            },
            "type": "array"
          },
          "deltas": {
            "items": {
              "$ref": "#/components/schemas/OrderHealthDeltaCriteria"
            },
            "type": "array"
          },
          "durationRange": {
            "$ref": "#/components/schemas/OrderDurationRange"
          },
          "shipmentStatus": {
            "description": "The overall timeliness of the order (EARLY, LATE, ON_TIME).",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          }
        },
        "title": "OrderHealthCriteria",
        "type": "object"
      },
      "OrderHealthDateCriteria": {
        "description": "To match orders based on target date range for estimated time of arrival.\n\nWhen operator is ON_OR_AFTER, now + offsetMinutes or the startDateTime is used as the date.\n\nWhen operator is ON_OR_BEFORE, now + offsetMinutes or the endDateTime is used as the date.\n\nConstruct absolute ranges with both startDateTime and endDateTime with null offsetMinutes.\n\nConstruct relative ranges with offsetMinutes, where negative offset indicates time before now and positive offset indicates time after now.\n\nExample: Now and the following 10 days => offsetMinutes: 14400, operator: WITHIN.\n\nExample: The last 5 hours: offsetMinutes: -300, operator: WITHIN.\n\nExample: Before 8 hours from now: offsetMinutes: 480, operator: ON_OR_BEFORE.",
        "properties": {
          "endDateTime": {
            "description": "The end of the period in which the estimated time of arrival is expected to be.",
            "type": "string"
          },
          "offsetMinutes": {
            "description": "Duration in minutes defines the target range to match the estimated time of arrival.",
            "format": "int64",
            "type": "integer"
          },
          "operator": {
            "description": "Operator to define the target range to match the estimated time of arrival.",
            "enum": [
              "WITHIN",
              "ON_OR_BEFORE",
              "ON_OR_AFTER"
            ],
            "type": "string"
          },
          "startDateTime": {
            "description": "The start of the period in which the estimated time of arrival is expected to be.",
            "type": "string"
          }
        },
        "title": "OrderHealthDateCriteria",
        "type": "object"
      },
      "OrderHealthDeltaCriteria": {
        "description": "Match orders on the duration of the arrival status, also known as the delta between planned delivery window and estimated arrival of an order.\n\nThe value is represented in minutes and must be non-negative.\n\nRUNNING_EARLY implies that the estimated arrival is before the planned delivery window\n\nRUNNING_LATE implies that the estimated arrival is after the planned delivery window\n\nTo query orders that hit the delivery window, use EQUALS 0 minutes. Note that this matches only orders that are on time. For example, RUNNING_LATE with EQUALS 0 minutes will match on-time orders, but will not match orders that are running early.\n\nExample: RUNNING_EARLY by LESS_THAN 60 minutes\n\nExample: RUNNING_LATE by MORE_THAN 1440 minutes (1 day)",
        "properties": {
          "operator": {
            "description": "Operator for the value.",
            "enum": [
              "MORE_THAN",
              "LESS_THAN",
              "EQUALS"
            ],
            "type": "string"
          },
          "type": {
            "description": "Type of delta to match the duration between the planned and the estimated time of arrival.",
            "enum": [
              "RUNNING_EARLY",
              "RUNNING_LATE"
            ],
            "type": "string"
          },
          "value": {
            "description": "Duration in minutes defines the period between the planned and the estimated time of arrival.",
            "format": "int64",
            "type": "integer"
          }
        },
        "title": "OrderHealthDeltaCriteria",
        "type": "object"
      },
      "OrderIdentifier": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "PURCHASE_ORDER",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "INVOICE",
              "DELIVERY"
            ]
          },
          "value": {
            "type": "string"
          }
        },
        "description": "Customer provided identifier of the order."
      },
      "OrderIdentifierCriteria": {
        "description": "OrderIdentifierCriteria",
        "properties": {
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "enum": [
              "PURCHASE_ORDER",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "INVOICE",
              "DELIVERY",
              "STOCK_TRANSFER_ORDER"
            ],
            "type": "string"
          },
          "values": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderIdentifierCriteria",
        "type": "object"
      },
      "OrderIdentifierReference": {
        "properties": {
          "orderId": {
            "description": "Project44 generated id for the order.",
            "type": "string"
          },
          "orderIdentifier": {
            "description": "Value of order identifier. Has length between 1 and 50.",
            "type": "string"
          },
          "orderIdentifierAuthority": {
            "description": "The authority is the party responsible for managing creation of the order identifier. Either null or has length between 1 and 50.",
            "type": "string"
          },
          "orderType": {
            "description": "Type of the order. Required.",
            "enum": [
              "PURCHASE_ORDER",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "INVOICE",
              "DELIVERY",
              "STOCK_TRANSFER_ORDER"
            ],
            "type": "string"
          }
        },
        "title": "OrderIdentifierReference",
        "type": "object"
      },
      "OrderIdentifierType": {
        "enum": [
          "PURCHASE_ORDER",
          "SALES_ORDER",
          "INVOICE_ID",
          "WAREHOUSE_MOVEMENT_ORDER",
          "ADVANCED_SHIPMENT_NOTICE"
        ],
        "type": "string",
        "description": "Allowed order identifier types for package items."
      },
      "OrderItemAdditionalIdentifierCriteria": {
        "description": "OrderItemAdditionalIdentifierCriteria",
        "properties": {
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "description": "${OrderItemAdditionalIdentifierCriteria.apiModel.type.value}",
            "enum": [
              "DEPARTMENT",
              "SUB_DEPARTMENT",
              "CATEGORY",
              "GROUP",
              "FAMILY",
              "GENDER",
              "VENDOR",
              "MANUFACTURER",
              "PROMOTION",
              "SECTOR",
              "DIVISION",
              "CLASS",
              "SUB_CLASS",
              "CODE",
              "SEASON"
            ],
            "type": "string"
          },
          "values": {
            "description": "${OrderItemAdditionalIdentifierCriteria.apiModel.values.value}",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderItemAdditionalIdentifierCriteria",
        "type": "object"
      },
      "OrderItemDescriptionCriteria": {
        "properties": {
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "values": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderItemDescriptionCriteria",
        "type": "object"
      },
      "OrderItemIdentifierCriteria": {
        "description": "OrderItemIdentifierCriteria",
        "properties": {
          "operator": {
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "enum": [
              "STOCK_KEEPING_UNIT",
              "UNIVERSAL_PRODUCT_CODE",
              "SERIAL_NUMBER"
            ],
            "type": "string"
          },
          "values": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderItemIdentifierCriteria",
        "type": "object"
      },
      "OrderLocationCriteria": {
        "description": "OrderLocationCriteria",
        "properties": {
          "propertyCriteria": {
            "items": {
              "$ref": "#/components/schemas/OrderLocationPropertyCriteria"
            },
            "type": "array"
          },
          "stopCriteria": {
            "$ref": "#/components/schemas/OrderStopCriteria"
          }
        },
        "title": "OrderLocationCriteria",
        "type": "object"
      },
      "OrderLocationPropertyCriteria": {
        "description": "OrderLocationPropertyCriteria",
        "properties": {
          "operator": {
            "description": "${OrderLocationPropertyCriteria.apiModel.operator.value}",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "type": {
            "description": "${OrderLocationPropertyCriteria.apiModel.type.value}",
            "enum": [
              "POSTAL_CODE",
              "ADDRESS_LINES",
              "CITY",
              "STATE",
              "COUNTRY",
              "SUPPLIER_ID",
              "NAME"
            ],
            "type": "string"
          },
          "values": {
            "description": "${OrderLocationPropertyCriteria.apiModel.values.value}",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderLocationPropertyCriteria",
        "type": "object"
      },
      "OrderStopCriteria": {
        "description": "OrderStopCriteria",
        "properties": {
          "operator": {
            "description": "${OrderStopCriteria.apiModel.operator.value}",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ],
            "type": "string"
          },
          "values": {
            "description": "${OrderStopCriteria.apiModel.values.value}",
            "items": {
              "enum": [
                "ORIGIN",
                "DESTINATION",
                "VENDOR",
                "BILLING"
              ],
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "OrderStopCriteria",
        "type": "object"
      },
      "OrderSupplier": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "description": "The supplier of the order at vendor location."
      },
      "OrderTag": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ANALYST",
              "CARRIER",
              "CATEGORY",
              "COMMODITY",
              "DEPARTMENT",
              "DIRECTOR",
              "FAMILY",
              "GROUP",
              "MANAGER",
              "SECTOR",
              "BATCH"
            ]
          },
          "value": {
            "type": "string"
          }
        },
        "description": "Non-unique terms to describe how orders are managed within the organization. Used when searching and filtering by a specific department, team, category."
      },
      "OrderWebhookPayload": {
        "description": "Order webhook payload",
        "allOf": [
          {
            "$ref": "#/components/schemas/UnifiedWebhookInterface"
          },
          {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/InventoryOrder"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "dataType": {
                "type": "string",
                "enum": [
                  "InventoryOrder"
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "eventType": {
                "type": "string",
                "enum": [
                  "inventory.v1.order.upserted",
                  "inventory.v1.order.deleted"
                ]
              }
            }
          }
        ]
      },
      "OtherAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PickupAccessorials"
              },
              {
                "$ref": "#/components/schemas/DeliveryAccessorials"
              },
              {
                "$ref": "#/components/schemas/NonSpecificAccessorials"
              },
              {
                "$ref": "#/components/schemas/ExcessLengthAccessorials"
              }
            ],
            "description": "Accessorial code."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which does not require any additional details."
      },
      "OutOfGaugeContainerCount": {
        "type": "object",
        "properties": {
          "fortyFootContainerCount": {
            "type": "integer",
            "description": "Count of 40ft flat-rack containers",
            "default": 0
          },
          "twentyFootContainerCount": {
            "type": "integer",
            "description": "Count of 20ft flat-rack containers",
            "default": 0
          }
        }
      },
      "Package": {
        "description": "An object that represents the physical package e.g. a box on a handling unit.",
        "properties": {
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "description": {
            "description": "A brief description of the package and its contents.",
            "type": "string"
          },
          "freightClass": {
            "description": "The freight class in this package.",
            "enum": [
              "50",
              "55",
              "60",
              "65",
              "70",
              "77.5",
              "85",
              "92.5",
              "100",
              "110",
              "125",
              "150",
              "175",
              "200",
              "250",
              "300",
              "400",
              "500"
            ],
            "type": "string"
          },
          "involvedParties": {
            "description": "A list of parties and their identifiers related to the line item. These are your customers receiving this line item or your suppliers providing this line item.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "nmfcCodes": {
            "description": "A list of the NMFC codes associated with this shipment.",
            "items": {
              "$ref": "#/components/schemas/NmfcCode"
            },
            "type": "array"
          },
          "packageContainerType": {
            "description": "The type of the package.",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "PAIL",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "EACH",
              "FLAT",
              "LOOSE",
              "ROLL",
              "TUBE"
            ],
            "type": "string"
          },
          "packageContents": {
            "description": "A  description of the items contained in the package.",
            "items": {
              "$ref": "#/components/schemas/PackageContents"
            },
            "type": "array"
          },
          "packageDimensions": {
            "$ref": "#/components/schemas/CubicDimension"
          },
          "packageQuantity": {
            "description": "The number of packages on the handling unit identical to this one.",
            "format": "int32",
            "type": "integer"
          },
          "weightPerPackage": {
            "description": "Weight per package.",
            "type": "number"
          }
        },
        "title": "Package",
        "type": "object"
      },
      "PackageAccessorial": {
        "type": "object",
        "description": "Accessorial type for packages. Can be one of: RefrigeratedAccessorial, LiftgateAccessorial, HazmatAccessorial, or other accessorial types.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/RefrigeratedAccessorial"
          },
          {
            "$ref": "#/components/schemas/LiftgateAccessorial"
          },
          {
            "$ref": "#/components/schemas/HazmatAccessorial"
          }
        ]
      },
      "PackageContainerType": {
        "enum": [
          "BAG",
          "BALE",
          "BOX",
          "BUCKET",
          "BUNDLE",
          "CAN",
          "CARTON",
          "CASE",
          "COIL",
          "CRATE",
          "CYLINDER",
          "EACH",
          "FLAT",
          "LOOSE",
          "PAIL",
          "ROLL",
          "TUBE"
        ],
        "type": "string",
        "description": "Enumeration of supported package type codes."
      },
      "PackageContentIdentifier": {
        "description": "An identifier for the package contents.",
        "properties": {
          "type": {
            "description": "The type of the package content identifier.",
            "enum": [
              "PURCHASE_ORDER_NUMBER",
              "SKU_NUMBER",
              "DELIVERY_NUMBER"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the package content identifier.",
            "type": "string"
          }
        },
        "title": "PackageContentIdentifier",
        "type": "object"
      },
      "PackageContents": {
        "description": "An object that represents the contents contained in the package on the handling unit. Meant to assist .",
        "properties": {
          "countryOfManufacture": {
            "description": "Country of manufacture of line item.",
            "enum": [
              "US",
              "CA",
              "MX",
              "AG",
              "BB",
              "BS",
              "BZ",
              "CR",
              "CU",
              "DM",
              "DO",
              "GD",
              "GT",
              "HN",
              "HT",
              "JM",
              "KN",
              "LC",
              "NI",
              "PA",
              "SV",
              "TT",
              "VC",
              "AI",
              "AW",
              "BL",
              "BM",
              "BQ",
              "CW",
              "GL",
              "GP",
              "KY",
              "MF",
              "MQ",
              "MS",
              "PM",
              "PR",
              "SX",
              "TC",
              "UM",
              "VG",
              "VI",
              "AT",
              "BE",
              "BG",
              "CY",
              "CZ",
              "DK",
              "DE",
              "EE",
              "ES",
              "FI",
              "FR",
              "GB",
              "GR",
              "HR",
              "HU",
              "IE",
              "IT",
              "LT",
              "LU",
              "LV",
              "MT",
              "NL",
              "PL",
              "PT",
              "RO",
              "SE",
              "SK",
              "SI",
              "CH",
              "IS",
              "LI",
              "NO",
              "AL",
              "ME",
              "MK",
              "RS",
              "TR",
              "AD",
              "AX",
              "BA",
              "BV",
              "BY",
              "FO",
              "GG",
              "GI",
              "IM",
              "IO",
              "JE",
              "MC",
              "MD",
              "SJ",
              "SM",
              "TF",
              "UA",
              "VA",
              "AE",
              "AF",
              "AM",
              "AZ",
              "BD",
              "BH",
              "BN",
              "BT",
              "CN",
              "GE",
              "HK",
              "ID",
              "IL",
              "IN",
              "IQ",
              "IR",
              "JO",
              "JP",
              "KG",
              "KH",
              "KP",
              "KR",
              "KW",
              "KZ",
              "LA",
              "LB",
              "LK",
              "MM",
              "MN",
              "MO",
              "MV",
              "MY",
              "NP",
              "OM",
              "PH",
              "PK",
              "PS",
              "QA",
              "RU",
              "SA",
              "SG",
              "SY",
              "TH",
              "TJ",
              "TL",
              "TM",
              "TW",
              "UZ",
              "VN",
              "YE",
              "AO",
              "BF",
              "BI",
              "BJ",
              "BW",
              "CD",
              "CF",
              "CG",
              "CI",
              "CM",
              "CV",
              "DJ",
              "DZ",
              "EG",
              "EH",
              "ER",
              "ET",
              "GA",
              "GH",
              "GM",
              "GN",
              "GQ",
              "GW",
              "HM",
              "KE",
              "KM",
              "LR",
              "LS",
              "LY",
              "MA",
              "MG",
              "ML",
              "MR",
              "MU",
              "MW",
              "MZ",
              "NA",
              "NE",
              "NG",
              "RE",
              "RW",
              "SC",
              "SD",
              "SH",
              "SL",
              "SN",
              "SO",
              "SS",
              "ST",
              "SZ",
              "TD",
              "TG",
              "TN",
              "TZ",
              "UG",
              "YT",
              "ZA",
              "ZM",
              "ZW",
              "AR",
              "BO",
              "BR",
              "CL",
              "CO",
              "EC",
              "FK",
              "GF",
              "GS",
              "GY",
              "PE",
              "PY",
              "SR",
              "UY",
              "VE",
              "AS",
              "AU",
              "CC",
              "CK",
              "CX",
              "FJ",
              "FM",
              "GU",
              "KI",
              "MH",
              "MP",
              "NC",
              "NF",
              "NR",
              "NU",
              "NZ",
              "PF",
              "PG",
              "PN",
              "PW",
              "SB",
              "TK",
              "TO",
              "TV",
              "VU",
              "WF",
              "WS",
              "AQ",
              "EL",
              "UK",
              "XK",
              "XS",
              "XI"
            ],
            "type": "string"
          },
          "description": {
            "description": "A brief description of the contents.",
            "type": "string"
          },
          "hazmatDetails": {
            "description": "Required if the contents are hazardous materials. Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT).",
            "items": {
              "$ref": "#/components/schemas/HazmatDetails"
            },
            "type": "array"
          },
          "packageContentIdentifiers": {
            "description": "The identifiers associated with the contents.",
            "items": {
              "$ref": "#/components/schemas/PackageContentIdentifier"
            },
            "type": "array"
          },
          "packageContentQuantity": {
            "description": "The number of items contained in the package.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "PackageContents",
        "type": "object"
      },
      "PackageDetails": {
        "type": "object",
        "properties": {
          "dimensions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Dimensions"
              }
            ],
            "description": "The dimensions of the package."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HandlingUnitType"
              }
            ],
            "description": "The type of handling unit/package (PALLET, BOX, CRATE, etc.)."
          },
          "volume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "The volume of the package."
          },
          "weight": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingWeight"
              }
            ],
            "description": "The weight of the package."
          }
        },
        "description": "Physical details of the package."
      },
      "PackageItem": {
        "required": [],
        "type": "object",
        "properties": {
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemIdentifier"
            },
            "minItems": 1,
            "description": "The identifiers for this item (e.g., SKU, UPC)."
          },
          "orderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackageItemOrderIdentifier"
              }
            ],
            "description": "The order identifier this item belongs to."
          },
          "unitQuantity": {
            "type": "integer",
            "minimum": 1,
            "description": "The quantity of units for this item."
          }
        },
        "description": "Item within a package with order association."
      },
      "PackageItemOrderIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderIdentifierType"
              }
            ],
            "description": "The type of the order identifier. Must be one of: PURCHASE_ORDER, SALES_ORDER, INVOICE_ID, WAREHOUSE_MOVEMENT_ORDER, ADVANCED_SHIPMENT_NOTICE."
          },
          "value": {
            "type": "string",
            "description": "The value of the order identifier."
          }
        },
        "description": "Order identifier for a package item."
      },
      "PackageResponse": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageAccessorial"
            },
            "default": [],
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable to your package which may be noteworthy to the carrier."
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the package was created."
          },
          "destinationLocation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingLocation"
              }
            ],
            "description": "The destination location from the related order(s)."
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique project44-generated package identifier."
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageItem"
            },
            "minItems": 1,
            "description": "List of items in the package with order associations."
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "minItems": 1,
            "description": "The identifiers that can identify this package (e.g., DELIVERY_NUMBER, OLPN)."
          },
          "isStackable": {
            "type": "boolean",
            "default": false,
            "description": "Flag indicating whether this package is stackable."
          },
          "lastModifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the package was last modified."
          },
          "originLocation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingLocation"
              }
            ],
            "description": "The origin location from the related order(s)."
          },
          "package": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackageDetails"
              }
            ],
            "description": "Physical details of the package."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PackageStatus"
              }
            ],
            "default": "UNASSIGNED",
            "description": "The status of the package in the tour planning workflow."
          }
        },
        "description": "Package data transfer object with database fields."
      },
      "PackageResponsePage": {
        "required": [],
        "type": "object",
        "properties": {
          "paginationInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaginationInfo"
              }
            ],
            "description": "Pagination information."
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageResponse"
            },
            "description": "The list of package results."
          }
        },
        "description": "Paginated response of packages."
      },
      "PackageStatus": {
        "enum": [
          "UNASSIGNED",
          "ASSIGNED",
          "CONFIRMED"
        ],
        "type": "string",
        "description": "Status of a package in the tour planning workflow."
      },
      "PackagingTypeCode": {
        "enum": [
          "BAG",
          "BAL",
          "BBL",
          "BSK",
          "BIN",
          "BOX",
          "BXT",
          "BCH",
          "BDL",
          "CAB",
          "CAG",
          "CAN",
          "CBY",
          "CAR",
          "CTN",
          "CAS",
          "CSK",
          "CHS",
          "COL",
          "CNT",
          "COR",
          "CRT",
          "CYL",
          "DRM",
          "DBK",
          "ENV",
          "FIR",
          "GLD",
          "HPR",
          "HGH",
          "HRB",
          "INT",
          "JAR",
          "JCN",
          "KEG",
          "KIT",
          "LIF",
          "LBK",
          "LSE",
          "MXD",
          "OTH",
          "PKG",
          "PCK",
          "PAL",
          "PAT",
          "PCS",
          "PLN",
          "RCK",
          "REL",
          "ROL",
          "SKD",
          "SLP",
          "SPL",
          "TNK",
          "TBN",
          "TRY",
          "TRU",
          "TRK",
          "TUB",
          "TBE",
          "UNT",
          "VPK",
          "WRP"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "PaginationInfo": {
        "description": "Pagination information about a collection of resources.",
        "properties": {
          "pageNumber": {
            "description": "Matching page number given the supplied PaginationParameters.",
            "format": "int32",
            "type": "integer"
          },
          "pageSize": {
            "description": "Page size matching the PaginationParameters.",
            "format": "int32",
            "type": "integer"
          },
          "total": {
            "description": "Total number of resource items matching the supplied criteria.",
            "format": "int64",
            "type": "integer"
          }
        },
        "title": "PaginationInfo",
        "type": "object"
      },
      "PaginationParameters": {
        "description": "Parameters which define a requested page of resources.",
        "properties": {
          "pageNumber": {
            "description": "The page of items that should be returned for a collection of resources. The min value should be one, and the max value should be less than the number of total pages for the collection. The page number is combined with the page size.",
            "format": "int32",
            "type": "integer"
          },
          "pageSize": {
            "description": "The max number of items returned in a collection of resources.  This value should be at least one.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "PaginationParameters",
        "type": "object"
      },
      "ParcelCapacityProviderPushStatusUpdate": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "description": {
            "description": "A description of the reason for the status of the status update.",
            "type": "string"
          },
          "estimatedTimeOfArrival": {
            "description": "Latest estimated arrival time to the final stop.",
            "type": "string"
          },
          "eventType": {
            "description": "The event corresponding to the status update that is being submitted. Certain events require a combination of fields to be submitted. For example: a POSITION_UPDATE event requires the location to be submitted, and the ETA eventrequires the estimatedTimeOfArrival to be submitted. Events may not require any additional information outside of the event type. An EXCEPTION eventdoes not require any additional information outside of the already required fields on the request. ",
            "enum": [
              "POSITION_UPDATE",
              "ETA",
              "EXCEPTION",
              "DELIVERY_MISSED",
              "LOADED_FOR_DELIVERY",
              "OUT_FOR_DELIVERY",
              "RETURN_TO_SENDER",
              "SHIPMENT_RECEIVED",
              "SHIPMENT_CREATED",
              "AVAILABLE_FOR_PICKUP",
              "PICKED_UP",
              "ARRIVED_AT_STOP",
              "DEPARTED_STOP",
              "DELIVERED",
              "CANCELED",
              "DELAYED",
              "HELD"
            ],
            "type": "string"
          },
          "location": {
            "$ref": "#/components/schemas/ParcelLocation"
          },
          "shipmentIdentifiers": {
            "description": "A list of shipment identifiers that can be used to track the shipment.",
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentIdentifier"
            },
            "type": "array"
          },
          "timestamp": {
            "description": "The timestamp of this status update. (format: yyyy-MM-dd'T'HH:mm:ssZ).",
            "type": "string"
          }
        },
        "title": "ParcelCapacityProviderPushStatusUpdate",
        "type": "object"
      },
      "ParcelLocation": {
        "description": "A parcel location object.",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          }
        },
        "title": "ParcelLocation",
        "type": "object"
      },
      "ParcelShipment": {
        "description": "A parcel shipment object.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/ParcelShipmentApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "id": {
            "description": "The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.",
            "format": "int64",
            "type": "integer"
          },
          "masterShipmentId": {
            "description": "The project44-generated id for the shipment. This ID may be used when this shipment passes between different modes.This may not be provided when creating a shipment, but will always be returned in the shipment confirmation.",
            "format": "uuid",
            "type": "string"
          },
          "parcelLegId": {
            "description": "Identifies the leg of the journey. Each piece of equipment has a unique id for each mode that it travels on.This id may be used in subsequent API calls to reference this shipment leg.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentAttributes": {
            "description": "A user-defined list of shipment attributes that are associated with the shipment",
            "items": {
              "$ref": "#/components/schemas/Attribute"
            },
            "type": "array"
          },
          "shipmentIdentifiers": {
            "description": "A user-defined list of shipment identifiers that are unique to this shipment and carrier identifier. These may be used in subsequent API calls along with the carrier identifier to reference a shipment. They may also be used by project44 to track the shipment. Only one shipment identifier of each type may be provided. Currently, parcel tracking only accepts shipment identifier with type 'TRACKING_NUMBER'.",
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "description": "A list of shipment stops that allow the ability to specify appointment windows ",
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentStop"
            },
            "type": "array"
          }
        },
        "title": "ParcelShipment",
        "type": "object"
      },
      "ParcelShipmentApiConfiguration": {
        "description": "Contains fields used to configure the Parcel shipment API.",
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "ParcelShipmentApiConfiguration",
        "type": "object"
      },
      "ParcelShipmentConfirmation": {
        "description": "Parcel shipment confirmation for a single package.",
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/ParcelShipment"
          },
          "shipments": {
            "description": "The created shipment or shipments, including project44-calculated shipment stop details and the project44 id of the shipment. This will contain all shipments that were created including the one originally requested. If this is a multi-package shipment additional shipments will be created, one for each package.",
            "items": {
              "$ref": "#/components/schemas/ParcelShipment"
            },
            "type": "array"
          }
        },
        "title": "ParcelShipmentConfirmation",
        "type": "object"
      },
      "ParcelShipmentDeleteConfirmation": {
        "description": "Parcel shipment delete confirmation.",
        "properties": {
          "infoMessages": {
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          }
        },
        "title": "ParcelShipmentDeleteConfirmation",
        "type": "object"
      },
      "ParcelShipmentIdentifier": {
        "properties": {
          "type": {
            "description": "Parcel shipment identifier type.",
            "enum": [
              "TRACKING_NUMBER"
            ],
            "type": "string"
          },
          "value": {
            "description": "Parcel shipment identifier type.",
            "type": "string"
          }
        },
        "title": "ParcelShipmentIdentifier",
        "type": "object"
      },
      "ParcelShipmentState": {
        "properties": {
          "actualDeliveryTimestamp": {
            "type": "string"
          },
          "createdAtTimestamp": {
            "type": "string"
          },
          "estimatedDeliveryTimestamp": {
            "type": "string"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "masterShipmentId": {
            "format": "uuid",
            "type": "string"
          },
          "parcelLegId": {
            "format": "uuid",
            "type": "string"
          },
          "pickedUpTimestamp": {
            "type": "string"
          },
          "shipmentAttributes": {
            "description": "A user-defined list of shipment attributes that are associated with the shipment",
            "items": {
              "$ref": "#/components/schemas/Attribute"
            },
            "type": "array"
          },
          "shipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "description": "A list of shipment stops that allow the ability to specify appointment windows ",
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentStop"
            },
            "type": "array"
          }
        },
        "title": "ParcelShipmentState",
        "type": "object"
      },
      "ParcelShipmentStatus": {
        "properties": {
          "latestStatusUpdate": {
            "$ref": "#/components/schemas/ParcelShipmentStatusUpdate"
          },
          "shipment": {
            "$ref": "#/components/schemas/ParcelShipmentState"
          },
          "statusUpdates": {
            "items": {
              "$ref": "#/components/schemas/ParcelShipmentStatusUpdate"
            },
            "type": "array"
          }
        },
        "title": "ParcelShipmentStatus",
        "type": "object"
      },
      "ParcelShipmentStatusReason": {
        "properties": {
          "code": {
            "description": "The code that further describes the status event.",
            "enum": [
              "DELAYED",
              "DELIVERED",
              "CANCELED",
              "HELD",
              "EXCEPTION",
              "DELIVERY_MISSED",
              "DELIVERY_APPOINTMENT",
              "RETURN_TO_SENDER",
              "AVAILABLE_FOR_PICKUP",
              "NOT_FOUND",
              "SHIPMENT_CREATED",
              "PICKED_UP",
              "NONE",
              "RECEIVED",
              "ARRIVED",
              "DEPARTED",
              "LOADED_FOR_DELIVERY",
              "OUT_FOR_DELIVERY",
              "TIMED_OUT",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "description": {
            "description": "The description of the status event provided by the carrier.",
            "type": "string"
          }
        },
        "title": "ParcelShipmentStatusReason",
        "type": "object"
      },
      "ParcelShipmentStatusUpdate": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "localTimeZone": {
            "description": "Local time zone of where the status event took place.",
            "type": "string"
          },
          "retrievalDateTime": {
            "description": "The dateTime that p44 received the status event from the carrier.",
            "type": "string"
          },
          "statusCode": {
            "description": "The status code for this status update. This field will always be populated.",
            "enum": [
              "INFO",
              "PRE_TRANSIT",
              "AT_STOP",
              "IN_TRANSIT",
              "OUT_TO_STOP",
              "COMPLETED"
            ],
            "type": "string"
          },
          "statusReason": {
            "$ref": "#/components/schemas/ParcelShipmentStatusReason"
          },
          "stopId": {
            "description": "The id of stop that the status event occurred at. Optional.",
            "format": "int64",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of stop that the status event occurred at. Optional.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          },
          "timestamp": {
            "description": "The datetime the carrier provided signifying when a status event occurred.",
            "type": "string"
          }
        },
        "title": "ParcelShipmentStatusUpdate",
        "type": "object"
      },
      "ParcelShipmentStop": {
        "description": "A parcel shipment stop object.",
        "properties": {
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "id": {
            "description": "The id of this stop. Response only field.",
            "format": "int64",
            "type": "integer"
          },
          "location": {
            "$ref": "#/components/schemas/ParcelLocation"
          },
          "parcelShipmentStopType": {
            "description": "The type of stop that the appointment window references.",
            "enum": [
              "ORIGIN",
              "DESTINATION",
              "TERMINAL"
            ],
            "type": "string"
          }
        },
        "title": "ParcelShipmentStop",
        "type": "object"
      },
      "ParcelWebhookEndpoint": {
        "description": "A parcel webhook endpoint.",
        "properties": {
          "includeFullHistory": {
            "description": "Include full update history",
            "type": "boolean"
          },
          "password": {
            "description": "Specify password if endpoint requires authentication.",
            "type": "string"
          },
          "showLatestUpdate": {
            "description": "Separately show latest update",
            "type": "boolean"
          },
          "url": {
            "description": "URL to which a POST request will be made with the content of the status update for a specific parcel shipment.",
            "type": "string"
          },
          "username": {
            "description": "Specify username if endpoint requires authentication.",
            "type": "string"
          }
        },
        "required": [],
        "title": "ParcelWebhookEndpoint",
        "type": "object"
      },
      "Party": {
        "properties": {
          "addressInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PartyAddress"
              }
            ],
            "description": "Address of the listed party."
          },
          "contactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Individual contact information for the party."
          },
          "identifyingCodes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IdentifyingCodes"
              }
            ],
            "description": "DCSA ocean standard identifying codes for the party."
          },
          "locationIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/RatingLocationIdentifier"
            },
            "type": "array",
            "description": "Identifiers for the location of the party."
          },
          "partyType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PartyType"
              }
            ],
            "description": "The relationship the shipper has to the party, relevant to the shipment."
          },
          "vatNumber": {
            "type": "string",
            "description": "Optional, VAT number of the listed party, if applicable."
          }
        },
        "type": "object",
        "required": []
      },
      "PartyAddress": {
        "properties": {
          "addressLines": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "maxItems": 3,
            "description": "Street name, number, direction, PO box, etc. Only three address lines are currently permitted."
          },
          "addressLabel": {
            "type": "string",
            "description": "The project44-generated label for the address persisted in location-service."
          },
          "city": {
            "type": "string",
            "description": "Name of city, town, etc."
          },
          "country": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CountryCode"
              }
            ],
            "description": "ISO 3166 Standard Country Abbreviation. Default US."
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The project44-generated identifier for the address persisted in location-service."
          },
          "postalCode": {
            "type": "string",
            "description": "The ZIP or postal code."
          },
          "state": {
            "type": "string",
            "description": "Abbreviation of state, province, district, etc."
          }
        },
        "type": "object",
        "description": "A postal address."
      },
      "PartyType": {
        "enum": [
          "SHIPPER",
          "CONSIGNEE",
          "BILL_TO",
          "NOTIFY_PARTY",
          "BOOKING_AGENT",
          "CARRIER_BOOKING_OFFICE"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "PatchDocument": {
        "type": "object",
        "properties": {
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Identifier"
            },
            "description": "The list of identifiers related to this document."
          },
          "mode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentMode"
              }
            ],
            "description": "The mode of transportation for this document."
          },
          "name": {
            "type": "string",
            "description": "The name of this document."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DocumentType"
              }
            ],
            "description": "The type of this document."
          }
        }
      },
      "Payment": {
        "required": [],
        "type": "object",
        "properties": {
          "terms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentTerms"
              }
            ],
            "description": "Freight Billing Terms for the shipment."
          }
        }
      },
      "PaymentTerms": {
        "enum": [
          "Prepaid",
          "Collect",
          "Third Party"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Permission": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "writeOnly": true
          }
        }
      },
      "PickupAccessorials": {
        "enum": [
          "NCPU",
          "LTDPU",
          "AIRPU",
          "CAMPPU",
          "CHRCPU",
          "CLUBPU",
          "CNVPU",
          "CONPU",
          "EDUPU",
          "FARMPU",
          "GOVPU",
          "GROPU",
          "HOSPU",
          "HOTLPU",
          "MILPU",
          "MINEPU",
          "NARPU",
          "NURSPU",
          "PARKPU",
          "PIERPU",
          "PRISPU",
          "RESPU",
          "RSRTPU",
          "SSTORPU",
          "UTLPU",
          "NBPU",
          "HDAYPU",
          "WEPU",
          "SATPU",
          "SUNPU",
          "APPTPU",
          "CERTPU",
          "CFSPU",
          "COMPU",
          "DVALPU",
          "DOCKPU",
          "FBEDPU",
          "LGPU",
          "INPU",
          "MALLPU",
          "OVSZEPU",
          "PJACKPU",
          "SORTPU",
          "XCHGPU",
          "XFERPU",
          "SHIPLDPU"
        ],
        "description": "An enumeration."
      },
      "PickupAppointmentDetails": {
        "type": "object",
        "properties": {
          "end": {
            "type": "string",
            "description": "Ending appointment date (with or without time) the shipment is requested to be picked up.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          },
          "start": {
            "type": "string",
            "description": "Starting appointment date (with or without time) the shipment is requested to be picked up.Required when accessorials.code list includes APTP.Valid Formats: YYYY-MM-DDTHH:mm:ss.sss (ISO 8601)",
            "format": "date-time"
          }
        }
      },
      "PlannedVesselRouteSegment": {
        "type": "object",
        "properties": {
          "fromStopId": {
            "type": "string",
            "format": "uuid"
          },
          "toStopId": {
            "type": "string",
            "format": "uuid"
          },
          "transportationMode": {
            "type": "string",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ]
          },
          "vesselName": {
            "type": "string"
          },
          "vesselImo": {
            "type": "string"
          },
          "vesselMmsi": {
            "type": "string"
          }
        },
        "description": "Planned vessel route segments with identifiers for this shipment. This is used to determine whether the shipment is on a planned route."
      },
      "Po": {
        "type": "object",
        "properties": {
          "additionalShipperInfo": {
            "type": "string",
            "description": "Additional information from shipper per line item."
          },
          "number": {
            "type": "string",
            "description": "The Purchase Order number."
          },
          "pieces": {
            "type": "integer",
            "description": "Total pieces associated with the Purchase Order."
          },
          "palletized": {
            "type": "boolean",
            "description": "Indicates whether or not the pieces associated with the purchase order are on a pallet/slip/skid or not."
          },
          "weight": {
            "type": "integer",
            "description": "Total weight associated with the Purchase Order."
          }
        }
      },
      "PodDischargeLoad": {
        "properties": {
          "date": {
            "description": "The first date in this timespan, in ISO-8601 format",
            "type": "string"
          },
          "podDischargeP25": {
            "description": "For p44 tracked containers, the 25th percentile of days between the discharge event and gate-out event.",
            "format": "double",
            "type": "number"
          },
          "podDischargeP50": {
            "description": "For p44 tracked containers, the median of days between the discharge event and gate-out event.",
            "format": "double",
            "type": "number"
          },
          "podDischargeP75": {
            "description": "For p44 tracked containers, the 75th percentile of days between the discharge event and gate-out event.",
            "format": "double",
            "type": "number"
          },
          "podLoadP25": {
            "description": "For p44 tracked containers, the 25th percentile of days between the gate-in event and vessel load event.",
            "format": "double",
            "type": "number"
          },
          "podLoadP50": {
            "description": "For p44 tracked containers, the median of days between the gate-in event and vessel load event.",
            "format": "double",
            "type": "number"
          },
          "podLoadP75": {
            "description": "For p44 tracked containers, the 75th percentile of days between the gate-in event and vessel load event.",
            "format": "double",
            "type": "number"
          }
        },
        "title": "PodDischargeLoad",
        "type": "object"
      },
      "PortDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "estimatedDatetime": {
            "type": "string",
            "description": "Date and Time connected to the port.When Port type is PORT_OF_LOADING then it's estimated departure date and time from origin portWhen Port type is PORT_OF_DISCHARGE then it's estimated arrival date and time at destination port",
            "format": "date-time"
          },
          "location": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingLocation"
              }
            ],
            "description": "The location of the port."
          },
          "portType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PortType"
              }
            ],
            "description": "Port type"
          }
        }
      },
      "PortIntelligence": {
        "properties": {
          "anchorMonthly": {
            "description": "Days between vessels arriving within 50nmi of port and mooring at berth, aggregated by calender month.",
            "items": {
              "$ref": "#/components/schemas/DateQuartiles"
            },
            "type": "array"
          },
          "anchorWeekly": {
            "description": "Days between vessels arriving within 50nmi of port and mooring at berth, aggregated by calender week.",
            "items": {
              "$ref": "#/components/schemas/DateQuartiles"
            },
            "type": "array"
          },
          "approachingDaily": {
            "description": "Number of vessels having the port as their destination.",
            "items": {
              "$ref": "#/components/schemas/VesselSchedule"
            },
            "type": "array"
          },
          "berthingMonthly": {
            "description": "Days between vessels mooring and unmooring, aggregated by calender month.",
            "items": {
              "$ref": "#/components/schemas/DateQuartiles"
            },
            "type": "array"
          },
          "berthingWeekly": {
            "description": "Days between vessels mooring and unmooring, aggregated by calender week.",
            "items": {
              "$ref": "#/components/schemas/DateQuartiles"
            },
            "type": "array"
          },
          "dwellMonthly": {
            "description": "Days spent by p44 tracked containers dwelling in port, aggregated by calender month.",
            "items": {
              "$ref": "#/components/schemas/PodDischargeLoad"
            },
            "type": "array"
          },
          "dwellWeekly": {
            "description": "Days spent by p44 tracked containers dwelling in port, aggregated by calender week.",
            "items": {
              "$ref": "#/components/schemas/PodDischargeLoad"
            },
            "type": "array"
          },
          "portLocode": {
            "description": "The UN/LOCODE of the port.",
            "type": "string"
          },
          "portName": {
            "description": "The name of the port.",
            "type": "string"
          }
        },
        "title": "PortIntelligence",
        "type": "object"
      },
      "PortIntelligenceCollection": {
        "properties": {
          "ports": {
            "description": "List of port intelligence summaries.",
            "items": {
              "$ref": "#/components/schemas/PortIntelligence"
            },
            "type": "array"
          }
        },
        "title": "PortIntelligenceCollection",
        "type": "object"
      },
      "PortType": {
        "enum": [
          "PORT_OF_LOADING",
          "PORT_OF_DISCHARGE",
          "TRANSSHIPMENT_PORT"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "PreviousOceanBooking": {
        "required": [],
        "type": "object",
        "properties": {
          "bookingNumber": {
            "type": "string"
          },
          "lastSeenDateTime": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "PrimaryShipmentIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "CONTAINER_ID",
              "BILL_OF_LADING",
              "HOUSE_BILL_OF_LADING",
              "BOOKING_NUMBER",
              "SERIAL_NUMBER",
              "VEHICLE_IDENTIFICATION_NUMBER",
              "ORDER",
              "PRO",
              "TRACKING_NUMBER",
              "AIR_WAYBILL",
              "HOUSE_AIR_WAYBILL",
              "RAIL_CAR_ID",
              "WAYBILL",
              "TRAIN_NUMBER",
              "WAGON_ID",
              "CUSTOMER_REFERENCE",
              "UNKNOWN"
            ]
          },
          "value": {
            "type": "string"
          }
        },
        "description": "A shipment-level identifier which is intended to most uniquely refer to a shipment; it is derived based on a hierarchy of identifier types."
      },
      "ProductCategoryBreachDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "breachStartDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "productCategory": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "FROZEN_FOOD",
              "REFRIGERATED_FOOD",
              "HOT_PREPARED_FOODS",
              "FRESH_MEAT_AND_POULTRY",
              "FROZEN_MEAT_AND_SEAFOOD",
              "FRESH_SEAFOOD",
              "DAIRY_PRODUCTS",
              "FROZEN_DAIRY",
              "FRESH_PRODUCE",
              "TROPICAL_FRUITS_AND_VEGETABLES",
              "ROOT_VEGETABLES",
              "WATERMELONS_AND_CUCUMBERS",
              "VACCINES_AND_BIOLOGICS",
              "ULTRA_COLD_STORAGE_VACCINES",
              "BLOOD_AND_PLASMA_PRODUCTS",
              "STERILE_INJECTABLE_MEDICATIONS",
              "DIAGNOSTIC_KITS_AND_MEDICAL_TESTING_EQUIPMENT",
              "LITHIUM_ION_BATTERIES",
              "SEMICONDUCTORS_AND_MICROCHIPS",
              "RUBBER_AND_POLYMER_BASED_AUTO_PARTS",
              "FRESH_CUT_FLOWERS",
              "TROPICAL_FLOWERS"
            ]
          }
        }
      },
      "ProNumberBlock": {
        "properties": {
          "blockEnd": {
            "format": "int64",
            "type": "integer"
          },
          "blockStart": {
            "format": "int64",
            "type": "integer"
          },
          "currentProNumber": {
            "format": "int64",
            "type": "integer"
          },
          "remainingProsInBlock": {
            "format": "int64",
            "type": "integer"
          },
          "vendorId": {
            "type": "string"
          }
        },
        "title": "ProNumberBlock",
        "type": "object"
      },
      "ProNumberBlockVendorId": {
        "properties": {
          "blockEnd": {
            "format": "int64",
            "type": "integer"
          },
          "blockStart": {
            "format": "int64",
            "type": "integer"
          },
          "checkDigit": {
            "format": "int64",
            "type": "integer"
          },
          "vendorId": {
            "type": "string"
          }
        },
        "title": "ProNumberBlockVendorId",
        "type": "object"
      },
      "ProNumberIdentifier": {
        "description": "A ProNumber response object.",
        "properties": {
          "proNumber": {
            "description": "The generated ProNumber.",
            "type": "string"
          },
          "vendorId": {
            "description": "The name of the vendor for which the ProNumber was generated.",
            "type": "string"
          }
        },
        "title": "ProNumberIdentifier",
        "type": "object"
      },
      "ProNumberQuery": {
        "description": "A ProNumber request object.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/ProNumberQueryApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "originLocation": {
            "$ref": "#/components/schemas/Address"
          }
        },
        "title": "ProNumberQuery",
        "type": "object"
      },
      "ProNumberQueryApiConfiguration": {
        "description": "Contains fields used to configure the PrePro Query API.",
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "ProNumberQueryApiConfiguration",
        "type": "object"
      },
      "QualityControlEventDetails": {
        "description": "Details of an event related to a quality control",
        "properties": {
          "code": {
            "description": "${QualityControlEventDetails.apiModel.code.value}",
            "enum": [
              "UNKNOWN",
              "SURVEY",
              "HELD",
              "DAMAGE_HELD",
              "PLANT_HELD",
              "QUALITY_CAMPAIGN_HELD",
              "CUSTOMS_HELD",
              "POWER_WASH_HELD",
              "OTHER_HELD",
              "QUALITY_CONTROL_HELD",
              "IMPORT_HELD",
              "RELEASE",
              "AVAILABLE",
              "EXPORT_SURVEY"
            ],
            "type": "string"
          }
        },
        "title": "QualityControlEventDetails",
        "type": "object"
      },
      "QuantityKind": {
        "required": [],
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "Required number of units."
          },
          "size": {
            "type": "number",
            "description": "Required dimensions of one unit."
          },
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LengthUnit"
              }
            ],
            "description": "Measuring unit."
          }
        },
        "additionalProperties": false
      },
      "Quote": {
        "required": [],
        "type": "object",
        "properties": {
          "bookable": {
            "type": "boolean",
            "description": "System flag that is set on creation to indicate if a quote is allowed to be booked; True for a carrier in-network, false for a carrier out-of-network."
          },
          "capacityProviderQuoteId": {
            "type": "string",
            "description": "Matching quote id on the provider's side."
          },
          "capacityProviderIdentifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
              }
            ],
            "description": "Reference to the desired carrier to request a quote from for the related shipment."
          },
          "capacityProviderName": {
            "type": "string",
            "description": "The name of the capacity provider's company."
          },
          "carrierMetrics": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CarrierMetrics"
              }
            ],
            "description": "Carrier metrics data from LMS containing performance metrics."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this quote was created. This value is read only.",
            "format": "date-time"
          },
          "deliveryDate": {
            "type": "string",
            "description": "Expected delivery date and time of the shipment.",
            "format": "date"
          },
          "expirationDateTime": {
            "type": "string",
            "description": "Quote expiration time set by the carrier.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "Project44-generated identifier for the quote.",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this quote was last modified. This value is read only.",
            "format": "date-time"
          },
          "pickupDate": {
            "type": "string",
            "description": "Expected pickup date and time of the shipment.",
            "format": "date"
          },
          "respondByDateTime": {
            "type": "string",
            "description": "Rate request expiration time that is set by the shipper.",
            "format": "date-time"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuoteStatus"
              }
            ],
            "description": "Current status of the quote."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuoteType"
              }
            ],
            "description": "Initiation type of the quote."
          },
          "totalRate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonetaryValue"
              }
            ],
            "description": "Total rate for the requested shipment."
          },
          "transportationMode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TransportationMode"
              }
            ],
            "description": "Transportation mode used to request the quote from a capacity provider.",
            "default": "TRUCKLOAD"
          }
        },
        "description": "The minimal version of quote dto. Only contains quote related data"
      },
      "QuoteStatus": {
        "enum": [
          "QUOTED",
          "PROCESSING",
          "CANCELLED",
          "DECLINED",
          "EXPIRED"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "QuoteType": {
        "enum": [
          "MANUAL",
          "API",
          "CONTRACT"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "RailAddress": {
        "description": "A postal address.",
        "properties": {
          "pointName": {
            "description": "Name of this point. Usually a city name but may also be the name of the junction, yard, or facility",
            "type": "string"
          },
          "state": {
            "description": "Abbreviation of state, province, district, etc.",
            "type": "string"
          }
        },
        "title": "RailAddress",
        "type": "object"
      },
      "RailArrivalEstimate": {
        "properties": {
          "estimatedArrivalCode": {
            "description": "The approximate arrival status, as estimated.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "estimatedArrivalWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "lastCalculatedDateTime": {
            "description": "When this eta was last computed. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          }
        },
        "title": "RailArrivalEstimate",
        "type": "object"
      },
      "RailEquipment": {
        "properties": {
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/RailEquipmentIdentifier"
          }
        },
        "title": "RailEquipment",
        "type": "object"
      },
      "RailEquipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the equipment identifier.",
            "enum": [
              "CONTAINER_ID",
              "TRAILER_ID",
              "RAIL_CAR_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the equipment identifier.",
            "type": "string"
          }
        },
        "title": "RailEquipmentIdentifier",
        "type": "object"
      },
      "RailEquipmentStatus": {
        "properties": {
          "equipment": {
            "$ref": "#/components/schemas/RailEquipment"
          },
          "equipmentRouteSegments": {
            "description": "Describe the route taken by this piece of equipment to each stop.",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentRouteSegment"
            },
            "type": "array"
          },
          "latestStatusUpdate": {
            "$ref": "#/components/schemas/RailEquipmentStatusUpdate"
          },
          "latestStopStatuses": {
            "description": "The most up-to-date statuses of the equipment in relation to each stop. One and only one status will always be returned for each stop. If the equipment does not have status 'COMPLETED' or 'DISPATCHED', this list will always contain one and only one stop status with a code of either 'EN_ROUTE' or 'ARRIVED'.",
            "items": {
              "$ref": "#/components/schemas/RailEquipmentStopStatus"
            },
            "type": "array"
          },
          "statusUpdates": {
            "description": "If requested, all available equipment status updates.",
            "items": {
              "$ref": "#/components/schemas/RailEquipmentStatusUpdate"
            },
            "type": "array"
          }
        },
        "title": "RailEquipmentStatus",
        "type": "object"
      },
      "RailEquipmentStatusUpdate": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/RailAddress"
          },
          "clmEventCode": {
            "description": "The 4-digit Event Code from the Rail Car Location Message.",
            "type": "string"
          },
          "clmSightingCode": {
            "description": "The 1-digit Sighting Code from the Rail Car Location Message.",
            "type": "string"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "statusCode": {
            "description": "The status code for this status update. This field will always be populated.",
            "enum": [
              "DISPATCHED",
              "IN_TRANSIT",
              "AT_STOP",
              "COMPLETED",
              "UNAUTHORIZED"
            ],
            "type": "string"
          },
          "statusReason": {
            "$ref": "#/components/schemas/RailStatusReason"
          },
          "stopNumber": {
            "description": "The stop number to which this status update corresponds, if any. This will be populated if the location of this update matches the location for a stop.",
            "format": "int32",
            "type": "integer"
          },
          "timestamp": {
            "description": "The timestamp of this status update in the time zone of the location. If this status update has no location, this timestamp will be in UTC. A time zone offset will always be provided. This field will always be populated.",
            "type": "string"
          },
          "trainIdentifier": {
            "description": "Train identifier that the rail event occurred on.",
            "type": "string"
          }
        },
        "title": "RailEquipmentStatusUpdate",
        "type": "object"
      },
      "RailEquipmentStopStatus": {
        "properties": {
          "arrivalCode": {
            "description": "The approximate arrival status of the shipment at the stop, as recorded.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "arrivalDateTime": {
            "description": "The recorded arrival time of the shipment at this stop, if available. This time will always be in the time zone of the stop, and a time zone offset will always be provided.",
            "type": "string"
          },
          "arrivalEstimate": {
            "$ref": "#/components/schemas/RailArrivalEstimate"
          },
          "departureDateTime": {
            "description": "The recorded departure time of the shipment from this stop, if available. This time will always be in the time zone of the stop, and a time zone offset will always be provided.",
            "type": "string"
          },
          "stopNumber": {
            "description": "The number of the shipment stop to which this status pertains.",
            "format": "int32",
            "type": "integer"
          },
          "stopStatusCode": {
            "description": "The status of the shipment relative to this stop -- whether it is presumed to be currently en route to the stop or whether it has been recorded as having arrived or departed the stop.",
            "enum": [
              "UNKNOWN",
              "EN_ROUTE",
              "ARRIVED",
              "DEPARTED"
            ],
            "type": "string"
          }
        },
        "title": "RailEquipmentStopStatus",
        "type": "object"
      },
      "RailLocation": {
        "description": "A physical location.",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/RailAddress"
          },
          "id": {
            "description": "The project44-generated id for this location.",
            "type": "string"
          }
        },
        "title": "RailLocation",
        "type": "object"
      },
      "RailShipment": {
        "properties": {
          "equipmentIdentifiers": {
            "description": "A user-defined list of equipment identifiers identifying rail equipment to be tracked as part of this shipment. This includes container ids and rail car ids. A rail shipment may only have 1 equipment identifier",
            "items": {
              "$ref": "#/components/schemas/RailEquipmentIdentifier"
            },
            "type": "array"
          },
          "id": {
            "description": "DEPRECATED: The project44-generated id for the rail shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use railLegId instead.",
            "format": "int64",
            "type": "integer"
          },
          "masterShipmentId": {
            "description": "This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this rail leg to the overall master shipment. Otherwise pass any valid new UUID to create a new shipment. If no masterShipmentId is passed on POST request a new UUID will be generated. This value will always be returned on all responses. ",
            "format": "uuid",
            "type": "string"
          },
          "railLegId": {
            "description": "Identifies the leg of the journey. Each piece of equipment has a unique id for each mode that it travels on.This id may be used in subsequent API calls to reference this shipment leg.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentIdentifiers": {
            "description": "A user-defined list of shipment identifiers that are unique to this shipment. You must pass in either a shipment identifier or a tracking start date time.",
            "items": {
              "$ref": "#/components/schemas/RailShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "description": "Contains the shipment's origin and destination.",
            "items": {
              "$ref": "#/components/schemas/RailShipmentStop"
            },
            "type": "array"
          },
          "trackingStartDateTime": {
            "description": "Tracking for this shipment will begin at this time. This should be set to the time when your shipment has been loaded into the container or rail car. Cannot be more than 90 days in the past or 90 days in the future. You must pass in either a shipment identifier or a tracking start date time.",
            "type": "string"
          }
        },
        "title": "RailShipment",
        "type": "object"
      },
      "RailShipmentConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/RailShipment"
          }
        },
        "title": "RailShipmentConfirmation",
        "type": "object"
      },
      "RailShipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the shipment identifier.",
            "enum": [
              "BILL_OF_LADING",
              "WAYBILL"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the shipment identifier.",
            "type": "string"
          }
        },
        "title": "RailShipmentIdentifier",
        "type": "object"
      },
      "RailShipmentStatus": {
        "properties": {
          "equipmentStatuses": {
            "description": "Status for each piece of equipment attached to this shipment.",
            "items": {
              "$ref": "#/components/schemas/RailEquipmentStatus"
            },
            "type": "array"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/RailShipment"
          }
        },
        "title": "RailShipmentStatus",
        "type": "object"
      },
      "RailShipmentStop": {
        "properties": {
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "id": {
            "description": "Project44 defined stop id. Always returned on response.",
            "format": "uuid",
            "type": "string"
          },
          "location": {
            "$ref": "#/components/schemas/RailLocation"
          },
          "stopName": {
            "description": "The optionally user-defined stop name of this stop. This is a freeform field. If no name is provided Project44 will default the name of each stop based on the address or stop number.",
            "type": "string"
          },
          "stopNumber": {
            "description": "The user-defined stop number, where '1' is the origin and '2' is the destination.",
            "format": "int32",
            "type": "integer"
          },
          "type": {
            "description": "How this stop relates to the shipment. This field must be null or absent when creating a shipment. The stop type will be determined by project44. ",
            "enum": [
              "UNKNOWN",
              "ORIGIN",
              "DESTINATION",
              "TRANSFER",
              "OTHER",
              "PORT_OF_LOADING",
              "TRANSSHIPMENT_PORT",
              "PORT_OF_DISCHARGE",
              "PICKUP",
              "DELIVERY",
              "RETURN",
              "WAREHOUSE",
              "HUB",
              "AIRPORT"
            ],
            "type": "string"
          }
        },
        "title": "RailShipmentStop",
        "type": "object"
      },
      "RailStatusReason": {
        "properties": {
          "code": {
            "description": "The reason code for the status of the status update.\nA status of 'DISPATCHED' will have one of the following reason codes: 'SCHEDULED' or 'ACQUIRING_LOCATION'.\nA status of 'IN_TRANSIT' will have one of the following reason codes: 'IN_MOTION' or 'IDLE'.\nA status of 'AT_STOP' will have one of the following reason codes: 'LOADED_ONTO_TRAIN', 'WAITING_TO_BE_UNLOADED', or 'UNLOADED'\nA status of 'COMPLETED' will have one of the following reason codes: 'TIMED_OUT', 'CANCELED', 'WAYBILL_CHANGED', or 'DEPARTED_FINAL_STOP'.",
            "enum": [
              "UNKNOWN",
              "SCHEDULED",
              "ACQUIRING_LOCATION",
              "IN_MOTION",
              "IDLE",
              "ARRIVED",
              "IN_GATE",
              "RAMPED",
              "DERAMPED",
              "NOTIFIED",
              "OUT_GATE",
              "DEPARTED_STOP",
              "TIMED_OUT",
              "CANCELED",
              "DEPARTED_FINAL_STOP",
              "WAYBILL_CHANGED",
              "UNAUTHORIZED"
            ],
            "type": "string"
          },
          "description": {
            "description": "A description of the reason for the status of the status update. This field is free-form text and should not be parsed.",
            "type": "string"
          }
        },
        "title": "RailStatusReason",
        "type": "object"
      },
      "RateIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "source": {
            "$ref": "#/components/schemas/RateIdentifierSource"
          },
          "type": {
            "$ref": "#/components/schemas/RateIdentifierType"
          },
          "value": {
            "type": "string",
            "description": "The ID of the rate source."
          }
        },
        "description": "The source which stands as the root for the rate on a booking.\nUsually, this means the price attached to the booking came from a spot-quote or a Contract.\n\nThis field is intended as an link between the booking and that source."
      },
      "RateIdentifierSource": {
        "enum": [
          "SYSTEM",
          "EXTERNAL",
          "UNKNOWN"
        ],
        "type": "string",
        "description": "The type of reference to the original source of the rate which applies to a booking.\nA `SYSTEM` identifier is internal to p44; an `EXTERNAL` identifier is known by a non-p44 system."
      },
      "RateIdentifierType": {
        "enum": [
          "SPOT_QUOTE",
          "CONTRACT"
        ],
        "type": "string",
        "description": "The type of rate identifier"
      },
      "RateQuote": {
        "description": "A rate quote from a single carrier.",
        "properties": {
          "alternateRateQuotes": {
            "description": "A list of alternate rate quotes from this capacity provider, if provided. These are typically rate quotes for other service levels the provider offers (e.g., guaranteed service levels).",
            "items": {
              "$ref": "#/components/schemas/AlternateRateQuote"
            },
            "type": "array"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "capacityProviderQuoteNumber": {
            "description": "The capacity provider's identifier for this rate quote, if provided.",
            "type": "string"
          },
          "carrierCode": {
            "description": "SCAC of the carrier to which this rate quote applies. This is used to differentiate among rate quotes from capacity providers that support multiple SCACs.",
            "type": "string"
          },
          "contractId": {
            "description": "This field is returned only for rate quotes from some brokers. It identifies the contract between the broker and capacity provider used to generate this rate quote. This can be used by other brokers or customers to gain access to that rate with the same capacity provider.",
            "type": "string"
          },
          "currencyCode": {
            "description": "The currency code for all monetary values in this rate quote.",
            "enum": [
              "USD",
              "CAD",
              "MXN",
              "EUR"
            ],
            "type": "string"
          },
          "currencyConversionAuditInfo": {
            "$ref": "#/components/schemas/CurrencyConversionAuditInfo"
          },
          "deliveryDateTime": {
            "description": "The delivery date and time for this rate quote in the timezone of the destination location, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "errorMessages": {
            "description": "System messages and messages from the capacity provider with severity 'ERROR'. No messages with severity 'INFO' or 'WARNING' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "id": {
            "description": "The quote ID from project44. This is an optional field",
            "type": "string"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "laneType": {
            "description": "Whether the shipment being quoted will stay within the carrier's network ('DIRECT' for a direct lane) or be tendered to another carrier before reaching its destination ('INTERLINE' for an interline lane), if indicated. (default: 'UNSPECIFIED')",
            "enum": [
              "DIRECT",
              "INTERLINE",
              "UNSPECIFIED"
            ],
            "type": "string"
          },
          "preferredCurrencyCode": {
            "description": "The currency code preferred for all monetary values with the suffix 'inPreferredCurrency' in this rate quote.",
            "enum": [
              "USD",
              "CAD",
              "MXN",
              "EUR"
            ],
            "type": "string"
          },
          "preferredSystemOfMeasurement": {
            "description": "The preferred system of measurement for all values with a unit in this rate quote. The default behavior is to return the unit of measurement specified by the carrier in the response.",
            "enum": [
              "METRIC",
              "IMPERIAL"
            ],
            "type": "string"
          },
          "quoteEffectiveDateTime": {
            "description": "The effective date and time for this quote, if provided.(format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "quoteExpirationDateTime": {
            "description": "The date and time this quote expires with the capacity provider, if provided. (format:yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "rateQuoteDetail": {
            "$ref": "#/components/schemas/RateQuoteDetail"
          },
          "requestedAccessorialServices": {
            "description": "A list of all accessorial services that were requested and their outcomes in this rate quote.",
            "items": {
              "$ref": "#/components/schemas/RequestedAccessorialService"
            },
            "type": "array"
          },
          "serviceLevel": {
            "$ref": "#/components/schemas/ServiceLevel"
          },
          "transitDays": {
            "description": "The number of service days to deliver the shipment being quoted after it is picked up, if provided.",
            "format": "int32",
            "type": "integer"
          },
          "transitDaysRange": {
            "$ref": "#/components/schemas/IntegerRange"
          }
        },
        "title": "RateQuote",
        "type": "object"
      },
      "RateQuoteApiConfiguration": {
        "description": "Contains fields used to configure the rate quote API.",
        "properties": {
          "accessorialServiceConfiguration": {
            "$ref": "#/components/schemas/AccessorialServiceConfiguration"
          },
          "enableUnitConversion": {
            "description": "If set to 'true', weight and length values in this rate quote query will be converted when necessary to the capacity provider's supported units. When 'false', an error will be returned for each capacity provider that does not support the provided weight and length units. (default: 'false')",
            "type": "boolean"
          },
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          },
          "timeout": {
            "description": "Number of seconds to wait for a capacity provider to return a rate quote. The max effective value is 60 seconds. (default: '15')",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "RateQuoteApiConfiguration",
        "type": "object"
      },
      "RateQuoteCollection": {
        "description": "Container for a list of rate quotes returned by a rate quote query.",
        "properties": {
          "rateQuotes": {
            "description": "List of rate quotes from all capacity providers requested.",
            "items": {
              "$ref": "#/components/schemas/RateQuote"
            },
            "type": "array"
          }
        },
        "title": "RateQuoteCollection",
        "type": "object"
      },
      "RateQuoteDetail": {
        "description": "Pricing details for this rate quote, including the total, subtotal, and a breakdown of charges, if provided.",
        "properties": {
          "charges": {
            "description": "A list of individual charges making up the total, if provided. Not returned for alternate rate quotes.",
            "items": {
              "$ref": "#/components/schemas/Charge"
            },
            "type": "array"
          },
          "subtotal": {
            "description": "Subtotal prior to discounts, if provided.",
            "type": "number"
          },
          "subtotalInPreferredCurrency": {
            "description": "Subtotal in preferred currency prior to discounts, if provided.",
            "type": "number"
          },
          "total": {
            "description": "The final total for this quote.",
            "type": "number"
          },
          "totalInPreferredCurrency": {
            "description": "The final total for this quote, in preferred currency.",
            "type": "number"
          }
        },
        "title": "RateQuoteDetail",
        "type": "object"
      },
      "RateQuoteQuery": {
        "description": "A request for rate quotes from one or more capacity providers based on the provided shipment characteristics and location information.",
        "properties": {
          "accessorialServices": {
            "description": "List of accessorial services to be quoted for this shipment.",
            "items": {
              "$ref": "#/components/schemas/AccessorialService"
            },
            "type": "array"
          },
          "apiConfiguration": {
            "$ref": "#/components/schemas/RateQuoteApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "deliveryWindow": {
            "$ref": "#/components/schemas/LocalDateTimeWindow"
          },
          "destinationAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "directionOverride": {
            "description": "An override of direction for all capacity provider accounts used by this request that have 'Enable API override of direction' set as 'true' in the project44 Self-Service Portal.This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.",
            "enum": [
              "SHIPPER",
              "CONSIGNEE",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "enhancedHandlingUnits": {
            "description": "A more granular representation of a line item. Required if no lineItems. Allows for order level tracking, more accurate rates, and more detailed BOLs. Currently not supported by all vendors. An enhancedHandlingUnit consists of one or more handling units, e.g. a pallet or a drum, one or more packages (the container on the handling unit e.g. a box), and package contents. NMFC codes and freight classes can be assigned at the handling unit and package level, while package contents can be associated with a DELIVERY_NUMBER, SKU_NUMBER, or PURCHASE_ORDER_NUMBER. Passing in both this field and lineItems is accepted, but at least one is required.",
            "items": {
              "$ref": "#/components/schemas/HandlingUnit"
            },
            "type": "array"
          },
          "lengthUnit": {
            "description": "Length measurement unit for all length values in this rate quote query. (default: 'IN')",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "lineItems": {
            "description": "The line items composing the shipment to be quoted. A line item consists of one or more packages, all of the same package type and with the same dimensions, freight class, and NMFC code. Each package, however, may have a different number of pieces and a different weight. Note that each capacity provider has a different maximum number of line items that they can quote. NOTE: This field is similar to, but not the same as, the enhancedHandlingUnits field. The handling units fields can contain more detailed information for use by both the carrier and the shipper. Passing in both this field and enhancedHandlingUnit is accepted, but at least one is required.",
            "items": {
              "$ref": "#/components/schemas/LineItem"
            },
            "type": "array"
          },
          "originAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "paymentTermsOverride": {
            "description": "An override of payment terms for all capacity provider accounts used by this request that have 'Enable API override of payment terms' set as 'true' in the project44 Self-Service Portal. This functionality is typically used in situations where both inbound and outbound shipments are common for a given capacity provider and account number.",
            "enum": [
              "PREPAID",
              "COLLECT",
              "THIRD_PARTY"
            ],
            "type": "string"
          },
          "pickupWindow": {
            "$ref": "#/components/schemas/LocalDateTimeWindow"
          },
          "preferredCurrency": {
            "description": "The currency that you would like the rate quote to be returned in, other than the default currency the carrier supports. If the currency is supported by the carrier, it will be returned in both the default currency and preferred currency fields. If the carrier does not support the requested currency, we will convert it on behalf of the carrier using the current exchange rate. The preferred currency will be returned in the “preferred currency” fields within the response. The carrier’s original currency will be returned in the default currency fields within the response. Exchange rate information will also be returned in the response for audit purposes.",
            "enum": [
              "USD",
              "CAD",
              "MXN"
            ],
            "type": "string"
          },
          "preferredSystemOfMeasurement": {
            "description": "The preferred system of measurement for all values with a unit in this rate quote. The default behavior is to return the unit of measurement specified by the carrier in the response.",
            "enum": [
              "METRIC",
              "IMPERIAL"
            ],
            "type": "string"
          },
          "totalLinearFeet": {
            "description": "The total linear feet that the shipment being quoted will take up in a trailer. Required only for volume LTL shipments. Customers who have enabled our Volume Visualizer product may submit rate requests without providing a value for totalLinearFeet. Linear footage will be automatically calculated, based on line item details, and submitted with your rate request. If a value is provided for totalLinearFeet, it will be submitted with the request and no calculation will be performed.",
            "format": "int32",
            "type": "integer"
          },
          "weightUnit": {
            "description": "Weight measurement unit for all weight values in this rate quote query. (default: 'LB')",
            "enum": [
              "LB",
              "KG"
            ],
            "type": "string"
          }
        },
        "title": "RateQuoteQuery",
        "type": "object"
      },
      "RateRequest": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "maxItems": 5,
            "description": "An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers."
          },
          "apiConfiguration": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingApiConfiguration"
              }
            ],
            "description": "Field for configuring the behavior of this API."
          },
          "capacityProviderIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
            },
            "description": "References to the desired carriers to request quotes from for the shipment."
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was created. This value is read only.",
            "format": "date-time"
          },
          "expirationDateTime": {
            "type": "string",
            "description": "The datetime of expiration for quotes within this rate request.",
            "format": "date-time"
          },
          "identifiers": {
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "type": "array",
            "maxItems": 20,
            "description": "Shipper-supplied identifiers for the shipment to be transported. Fully mutable."
          },
          "id": {
            "type": "string",
            "description": "The project44-generated identifier for the rate request.",
            "format": "uuid"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was last modified. This value is read only.",
            "format": "date-time"
          },
          "marketQuotes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MarketQuote"
            },
            "description": "A list of market rate provider quotes associated to the rate request."
          },
          "name": {
            "type": "string",
            "description": "The name or otherwise human-readable description of the shipment created."
          },
          "quotes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Quote"
            },
            "description": "A list of quotes associated to the rate request."
          },
          "rateDetail": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RateRequestDetail"
              }
            ],
            "description": "Contains information about how, when and where the shipment moves."
          },
          "ratingSourceMethod": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingSourceMethod"
              }
            ],
            "description": "Shipper made rate request by WebGUI or API.",
            "default": "API"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RateRequestStatus"
              }
            ],
            "description": "A descriptive state of the rate request.",
            "deprecated": true
          }
        },
        "description": "The general data model mirror what we stored in database"
      },
      "RateRequestDetail": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "description": "A shipper-provided list of custom key-value list pairs relevant to the shipment which are shared with the carrier."
          },
          "deliveryDate": {
            "type": "string",
            "description": "If provided, the delivery date must be on/after shipment date.",
            "format": "date"
          },
          "distanceToTravel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingDistanceMeasurement"
              }
            ],
            "description": "Optional shipper-provided distance for the shipment. When provided, this value overrides the contract-level distance in Contract Quotes"
          },
          "estimatedDeliveryDate": {
            "type": "string",
            "description": "An estimated delivery date that is calculated by project44.",
            "format": "date"
          },
          "pickupDate": {
            "type": "string",
            "description": "The pickup date must be on/before delivery date.",
            "format": "date"
          },
          "routeInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingRouteInfo"
              }
            ],
            "description": "Contains information about how the shipment moves from each stop to the next."
          },
          "shippingDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShippingDetails"
              }
            ],
            "description": "Contains information about how and what the shipment moves."
          },
          "shipmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatingShipmentDetails"
            },
            "description": "Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body."
          },
          "shipperContactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Contact method to reach the shipper making the rate request."
          }
        }
      },
      "RateRequestDetailQuery": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "description": "A shipper-provided list of custom key-value list pairs relevant to the shipment which are shared with the carrier."
          },
          "deliveryDate": {
            "type": "string",
            "description": "If provided, the delivery date must be on/after shipment date.",
            "format": "date"
          },
          "distanceToTravel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingDistanceMeasurement"
              }
            ],
            "description": "Optional shipper-provided distance for the shipment. When provided, this value overrides the contract-level distance in Contract Quotes"
          },
          "pickupDate": {
            "type": "string",
            "description": "The pickup date must be on/before delivery date.",
            "format": "date"
          },
          "routeInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingRouteInfo"
              }
            ],
            "description": "Contains information about how the shipment moves from each stop to the next."
          },
          "shippingDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShippingDetails"
              }
            ],
            "description": "Contains information about how and what the shipment moves."
          },
          "shipmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatingShipmentDetails"
            },
            "description": "Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body."
          },
          "shipperContactInfo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingContact"
              }
            ],
            "description": "Contact method to reach the shipper making the rate request."
          }
        }
      },
      "RateRequestQuery": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "type": "array",
            "maxItems": 5,
            "description": "An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers."
          },
          "apiConfiguration": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingApiConfiguration"
              }
            ],
            "description": "Field for configuring the behavior of this API."
          },
          "capacityProviderIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingCapacityProviderIdentifier"
            },
            "description": "References to the desired carriers to request quotes from for the shipment."
          },
          "expirationDateTime": {
            "type": "string",
            "description": "The datetime of expiration for quotes within this rate request.",
            "format": "date-time"
          },
          "identifiers": {
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "type": "array",
            "maxItems": 20,
            "description": "Shipper-supplied identifiers for the shipment to be transported. Fully mutable."
          },
          "name": {
            "type": "string",
            "description": "The name or otherwise human-readable description of the shipment created."
          },
          "rateDetail": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RateRequestDetailQuery"
              }
            ],
            "description": "Contains information about how, when and where the shipment moves."
          }
        },
        "description": "As a shipper, request a rate from carriers to transport a load across 1+ route segments."
      },
      "RateRequestStatus": {
        "enum": [
          "OPEN",
          "QUOTES_REQUESTED",
          "QUOTES_RECEIVED"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "RatingApiConfiguration": {
        "type": "object",
        "properties": {
          "enableSlotBooking": {
            "type": "boolean",
            "description": "The flag to indicate if a slot booking in Appointment Manager is needed.",
            "default": false
          },
          "ratingWebhookName": {
            "type": "string",
            "description": "An optional name of the webhook that will receive updates for this quote."
          }
        }
      },
      "RatingAppointmentDetails": {
        "type": "object",
        "properties": {
          "appointmentWindow": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ZonedDateTimeWindow"
              }
            ],
            "description": "Zoned time window which the carrier is expected to arrive at the stop."
          },
          "dockOperationWindow": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ZonedDateTimeWindow"
              }
            ],
            "description": "Zoned time window which the carrier is expected to arrive at the dock."
          }
        }
      },
      "RatingDistanceMeasurement": {
        "required": [],
        "type": "object",
        "properties": {
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingDistanceUnit"
              }
            ],
            "description": "The unit of measurement for this distance."
          },
          "value": {
            "type": "string",
            "description": "The numeric value of this distance, expressed as a string."
          }
        },
        "description": "A measure of distance with a value and unit."
      },
      "RatingDistanceUnit": {
        "enum": [
          "MI"
        ],
        "type": "string",
        "description": "An enumeration of distance units."
      },
      "RatingLocationIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/LocationIdentifierType"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "RatingRouteInfo": {
        "required": [],
        "type": "object",
        "properties": {
          "routeSegments": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatingRouteSegment"
            },
            "description": "Contains information about how the shipment moves from each stop to the next."
          },
          "stops": {
            "minItems": 2,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatingStop"
            },
            "description": "All stops associated with this shipment, in sequential order."
          }
        }
      },
      "RatingRouteSegment": {
        "required": [],
        "type": "object",
        "properties": {
          "fromStopId": {
            "type": "string",
            "description": "The start stop id of the route segment.",
            "format": "uuid"
          },
          "toStopId": {
            "type": "string",
            "description": "The end stop id of the route segment.",
            "format": "uuid"
          }
        }
      },
      "RatingShipmentDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable to your shipment which may be noteworthy to the carrier."
          },
          "deliveryStopId": {
            "type": "string",
            "description": "The unique ID for the location where the handling unit should be delivered.",
            "format": "uuid"
          },
          "description": {
            "type": "string",
            "description": "Free text space to describe the handling unit."
          },
          "handlingUnits": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HandlingUnit"
            },
            "description": "Content of the shipment to be transported."
          },
          "identifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "description": "The identifiers that can identify this load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as `PURCHASE_ORDER`."
          },
          "pickupStopId": {
            "type": "string",
            "description": "The unique ID for the location where the handling unit should be picked up.",
            "format": "uuid"
          }
        },
        "description": "Information which describes the entities being transported.\n    Comprised of items, this is a single definition of the item(s)\n    to be picked up and delivered at a relevant stop."
      },
      "RatingSourceMethod": {
        "enum": [
          "API",
          "WEBAPP"
        ],
        "type": "string",
        "description": "Method by which a shipper initiates a rate request."
      },
      "RatingStop": {
        "required": [],
        "type": "object",
        "properties": {
          "appointmentDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RatingAppointmentDetails"
              }
            ],
            "description": "Only applicable for pickup type of stop"
          },
          "contacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StopContact"
            },
            "description": "Shipper-supplied individuals who may be contacted for correspondence related to shipment handling at the stop."
          },
          "id": {
            "type": "string",
            "description": "The id of the stop.",
            "format": "uuid"
          },
          "location": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Location"
              }
            ],
            "description": "The location of the stop."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StopType"
              }
            ],
            "description": "The type of the given stop."
          }
        }
      },
      "ReasonCodeListResponse": {
        "type": "object",
        "properties": {
          "reasonCodes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of reason codes",
            "example": [
              "CANCEL_WEATHER",
              "CANCEL_DRIVER_UNAVAILABLE",
              "CANCEL_EQUIPMENT_ISSUE"
            ]
          },
          "status": {
            "type": "string",
            "description": "Status of the operation",
            "example": "SUCCESS"
          }
        }
      },
      "ReeferContainerCount": {
        "type": "object",
        "properties": {
          "fortyFootContainerCount": {
            "type": "integer",
            "description": "Count of 40ft flat-rack containers",
            "default": 0
          },
          "fortyFootHighCubeCount": {
            "type": "integer",
            "description": "Count of 40ft flat-rack high-cube containers",
            "default": 0
          },
          "twentyFootContainerCount": {
            "type": "integer",
            "description": "Count of 20ft flat-rack containers",
            "default": 0
          }
        }
      },
      "ReferenceNumbers": {
        "required": [],
        "type": "object",
        "properties": {
          "additionalReferences": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalReference"
            },
            "description": "A list of additional references. It is required to provide an additional references with 'CAPACITY_PROVIDER_ACCOUNT_CODE' and 'CAPACITY_PROVIDER_ACCOUNT_GROUP_CODE' names accompanied with appropriate values to reference correct carrier and credentials."
          },
          "bol": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "A list of Bill of Lading identifiers."
          },
          "masterBol": {
            "type": "string",
            "description": "Master Bill of Lading number for the shipment."
          },
          "pro": {
            "type": "string",
            "description": "Shipper's pre-assigned PRO number for the requested carrier. If not provided, one will be auto assigned by the carrier."
          },
          "po": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Po"
            },
            "description": "A list of purchase orders."
          },
          "quoteId": {
            "type": "string",
            "description": "Quote (estimate) number provided by the carrier after submitting a rate quote request."
          },
          "shipmentId": {
            "type": "string",
            "description": "Shipment Id (SID) number for the shipment."
          }
        }
      },
      "RefrigeratedAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "REFRIGERATED"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TempRangeKind"
              }
            ],
            "description": "Required temperature range."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which defines the acceptable temperature range for a transportation container."
      },
      "RefrigeratedClass": {
        "enum": [
          "AMBIENT",
          "CHILLED",
          "FROZEN",
          "DEEP_FROZEN"
        ],
        "type": "string",
        "description": "Temperature level for refrigerated trailers (different prices/carrier handling per level)."
      },
      "RefrigeratedTrailerDetails": {
        "type": "object",
        "required": [],
        "properties": {
          "refrigeratedClass": {
            "$ref": "#/components/schemas/RefrigeratedClass",
            "description": "Refrigerated temperature class: Ambient, Chilled, Frozen, Deep Frozen. Required when this object is provided."
          }
        },
        "description": "Trailer details when trailer type is REFRIGERATED. Intermediary model to allow future fields."
      },
      "RelatedLoadItemDescriptionFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the value of the related load items' descriptions.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: \n\n(loadItem.description EQUALS [A OR B OR C]) AND \n\n(loadItem.description EQUALS [D OR F])"
      },
      "RelatedLoadItemIdentifierFilter": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "SKU",
                "UPC"
              ]
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of the related load items' identifiers.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the type and values, and they are combined using an AND operator.\n\nExample: \n\n(loadItem.identifier.type EQUALS X AND loadItem.identifier.value EQUALS [A OR B OR C]) AND \n\n(loadItem.identifier.type EQUALS Y AND loadItem.identifier.value EQUALS [D OR F])"
      },
      "RelatedOrderAdditionalIdentifierFilter": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "CONTRACT",
                "LOAD",
                "MANUFACTURER",
                "PROMOTION",
                "SEASON",
                "VENDOR",
                "LAUNCH_CODE",
                "CUSTOMER_ORDER"
              ]
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of their related orders' additional identifiers.\n\nEither types or values must be present for each criterion.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the types and values, and they are combined using an AND operator.\n\nThe types and values criteria within each filter must be met by the same additional identifier, but distinct filters in this array may be satisfied by different additional identifiers in the same shipment. \n\nExample: \n\n(order.additionalIdentifier.type EQUALS [X OR Y] AND order.additionalIdentifier.type EQUALS [A OR B OR C]) AND \n\n(order.additionalIdentifier.type EQUALS [Z] AND order.additionalIdentifier.value EQUALS [D OR F])"
      },
      "RelatedOrderDateFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "description": "The tail end of an absolute time window.",
            "format": "date-time"
          },
          "offsetMinutes": {
            "type": "integer",
            "description": "Used to construct relative ranges where negative offset indicates time before startDateTime or Now and positive offset indicates time after startDateTime or Now.",
            "format": "int64"
          },
          "operator": {
            "type": "string",
            "enum": [
              "WITHIN",
              "ON_OR_BEFORE",
              "ON_OR_AFTER"
            ]
          },
          "relativeDateTimeWindow": {
            "type": "string",
            "description": "A sliding window that matches to common time definitions like \"today\" or \"tomorrow\".",
            "enum": [
              "YESTERDAY",
              "TODAY",
              "TOMORROW",
              "LAST_WEEK",
              "THIS_WEEK",
              "NEXT_WEEK",
              "THIS_MONTH",
              "LAST_MONTH",
              "NEXT_MONTH"
            ]
          },
          "relativeWindowTimeZoneOffset": {
            "type": "object",
            "properties": {
              "totalSeconds": {
                "type": "integer",
                "format": "int32"
              },
              "id": {
                "type": "string"
              },
              "rules": {
                "type": "object",
                "properties": {
                  "fixedOffset": {
                    "type": "boolean"
                  },
                  "transitions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "instant": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "duration": {
                          "type": "object",
                          "properties": {
                            "seconds": {
                              "type": "integer",
                              "format": "int64"
                            },
                            "zero": {
                              "type": "boolean"
                            },
                            "nano": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "negative": {
                              "type": "boolean"
                            },
                            "units": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "durationEstimated": {
                                    "type": "boolean"
                                  },
                                  "timeBased": {
                                    "type": "boolean"
                                  },
                                  "dateBased": {
                                    "type": "boolean"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "gap": {
                          "type": "boolean"
                        },
                        "dateTimeAfter": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "dateTimeBefore": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "overlap": {
                          "type": "boolean"
                        }
                      }
                    }
                  },
                  "transitionRules": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "month": {
                          "type": "string",
                          "enum": [
                            "JANUARY",
                            "FEBRUARY",
                            "MARCH",
                            "APRIL",
                            "MAY",
                            "JUNE",
                            "JULY",
                            "AUGUST",
                            "SEPTEMBER",
                            "OCTOBER",
                            "NOVEMBER",
                            "DECEMBER"
                          ]
                        },
                        "timeDefinition": {
                          "type": "string",
                          "enum": [
                            "UTC",
                            "WALL",
                            "STANDARD"
                          ]
                        },
                        "standardOffset": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "dayOfWeek": {
                          "type": "string",
                          "enum": [
                            "MONDAY",
                            "TUESDAY",
                            "WEDNESDAY",
                            "THURSDAY",
                            "FRIDAY",
                            "SATURDAY",
                            "SUNDAY"
                          ]
                        },
                        "dayOfMonthIndicator": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "localTime": {
                          "$ref": "#/components/schemas/LocalTime"
                        },
                        "midnightEndOfDay": {
                          "type": "boolean"
                        }
                      }
                    }
                  }
                }
              }
            },
            "description": "The timezone offset of the relativeDateTimeWindow."
          },
          "startDateTime": {
            "type": "string",
            "description": "The beginning of an absolute time window (if endDateTime is populated) or the anchor of a relative offset window (if offsetMinutes is populated).",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "enum": [
              "SUPPLIER_READY_START_DATETIME",
              "SUPPLIER_READY_END_DATETIME",
              "ORIGINAL_DELIVERY_START_DATETIME",
              "ORIGINAL_DELIVERY_END_DATETIME",
              "LAUNCH_DATETIME",
              "ORIGINAL_DELIVERY_ESTIMATE_DATETIME"
            ]
          }
        },
        "description": "Match shipments based on their related orders' datetimes, relative to a target range.\n\nValid combinations of parameters are as follows:\n\nWithin two absolute datetimes: WITHIN + startDateTime + endDateTime\n\nBefore an absolute datetime: ON_OR_BEFORE + endDateTime\n\nAfter an absolute datetime: ON_OR_AFTER + startDateTime\n\nBetween now and now +- X minutes: WITHIN + offsetMinutes\n\nBefore now +- X minutes: ON_OR_BEFORE + offsetMinutes\n\nAfter now +- X minutes: ON_OR_AFTER + offsetMinutes"
      },
      "RelatedOrderDeltaFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "durationInMinutes": {
            "minimum": 0,
            "type": "integer",
            "format": "int64"
          },
          "operator": {
            "type": "string",
            "enum": [
              "MORE_THAN",
              "MORE_THAN_OR_EQUALS",
              "LESS_THAN",
              "LESS_THAN_OR_EQUALS",
              "EQUALS",
              "NOT_EQUALS",
              "EXISTS",
              "NOT_EXISTS"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "RUNNING_EARLY",
              "RUNNING_LATE"
            ]
          }
        },
        "description": "Match shipments on the difference between planned delivery window and estimated arrival of a related order.\n\nThe value is represented in minutes and must be non-negative.\n\nRUNNING_EARLY implies that the estimated arrival is before the planned delivery window.\n\nRUNNING_LATE implies that the estimated arrival is after the planned delivery window.\n\nTo query orders that hit the delivery window, use EQUALS 0 minutes. Note that this matches only orders that are on time. For example, RUNNING_LATE with EQUALS 0 minutes will match on-time orders, but will not match orders that are running early.\n\nExample: RUNNING_EARLY by LESS_THAN 60 minutes\n\nExample: RUNNING_LATE by MORE_THAN 1440 minutes (1 day)"
      },
      "RelatedOrderIdentifierFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "PURCHASE_ORDER",
              "SALES_ORDER",
              "WAREHOUSE_MOVEMENT_ORDER",
              "ADVANCED_SHIPMENT_NOTICE",
              "INVOICE",
              "DELIVERY"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of the related orders' identifiers.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the type and values, and they are combined using an AND operator.\n\nExample: \n\n(orders.identifier.type EQUALS X AND orders.identifier.value EQUALS [A OR B OR C]) AND \n\n(orders.identifier.type EQUALS Y AND orders.identifier.value EQUALS [D OR F])"
      },
      "RelatedOrderIdentifierTypeFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "PURCHASE_ORDER",
                "SALES_ORDER",
                "WAREHOUSE_MOVEMENT_ORDER",
                "ADVANCED_SHIPMENT_NOTICE",
                "INVOICE",
                "DELIVERY"
              ]
            }
          }
        },
        "description": "Match shipments based on the identifier type of related orders.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (orders.identifier.type EQUALS [A OR B OR C])\n\nExample: (orders.identifier.type NOT_EQUALS A) AND (orders.identifier.type NOT_EQUALS B)"
      },
      "RelatedOrderInternalIdFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the internal order ID of related orders.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (orders.id EQUALS [A OR B OR C])\n\nExample: (orders.id NOT_EQUALS A) AND (orders.id NOT_EQUALS B)"
      },
      "RelatedOrderSupplierIdFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the supplier ID(s) of its related orders.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (order.supplier.name EQUALS [A OR B OR C])\n\nExample: (order.supplier.name CONTAINS A) AND (order.supplier.name NOT_EQUALS CAT)"
      },
      "RelatedOrderTagFilter": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ANALYST",
                "CARRIER",
                "CATEGORY",
                "COMMODITY",
                "DEPARTMENT",
                "DIRECTOR",
                "FAMILY",
                "GROUP",
                "MANAGER",
                "SECTOR",
                "BATCH"
              ]
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of their related orders' tags.\n\nEither types or values must be present for each criterion.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the types and values, and they are combined using an AND operator.\n\nThe types and values criteria within each filter must be met by the same tag, but distinct filters in this array may be satisfied by different tags in the same shipment. \n\nExample: \n\n(order.tag.type EQUALS [X OR Y] AND order.tag.type EQUALS [A OR B OR C]) AND \n\n(order.tag.type EQUALS [Z] AND order.tag.value EQUALS [D OR F])"
      },
      "RemitTo": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "description": "Primary Address line of the remit to company."
          },
          "address2": {
            "type": "string",
            "description": "Secondary Address of the remit to company."
          },
          "city": {
            "type": "string",
            "description": "City Name of the remit to company."
          },
          "country": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CountryCode"
              }
            ],
            "description": "Three letter country code for the destination location."
          },
          "name": {
            "type": "string",
            "description": "Name of the remit to company."
          },
          "postalCode": {
            "maxLength": 6,
            "minLength": 5,
            "type": "string",
            "description": "The 5-digit (or 6-characters for Canada) zip code of the remit to company."
          },
          "stateProvince": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StateProvinceCode"
              }
            ],
            "description": "Two letter state/province code of the remit to company."
          }
        }
      },
      "RequestEbol": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Accessorial"
              }
            ],
            "description": "A list of accessorials related to the shipment."
          },
          "bol": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Bol"
              }
            ],
            "description": "BOL object containing requested pickup date, function, test,requestor role and optional special instructions."
          },
          "billTo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLLocation"
              }
            ],
            "description": "A location where related shipment's billing should happen."
          },
          "commodities": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Commodities"
              }
            ],
            "description": "Commodities related to the shipment."
          },
          "customsBroker": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomsBroker"
              }
            ],
            "description": "Optional field to reference customs broker for cross-border shipments."
          },
          "destination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLLocation"
              }
            ],
            "description": "A location where related shipment's delivery should happen."
          },
          "images": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Images"
              }
            ],
            "description": "Indicate if you want ebol or shipping labels returned in the response"
          },
          "notifications": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Notification"
            },
            "description": "Include if you want notifications of shipment movements by text message or email."
          },
          "origin": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLLocation"
              }
            ],
            "description": "A location where the related shipment's pickup should happen."
          },
          "payment": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payment"
              }
            ],
            "description": "Payment terms related to the shipment such as Prepaid, Collect or Third Party."
          },
          "referenceNumbers": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReferenceNumbers"
              }
            ],
            "description": "Reference numbers related to the shipment such as Pro, QuoteId, MasterBol etc."
          },
          "shipmentTotals": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShipmentTotals"
              }
            ],
            "description": "Measurements related to the shipment."
          },
          "version": {
            "type": "string",
            "description": "Indicates which minor version of the Digital LTL Council Bill of Lading spec you are consuming Valid values: 2.0.0, 2.0.1, 2.1.0"
          }
        },
        "description": "As a shipper, request a eBOL from a carrier."
      },
      "RequestedAccessorialService": {
        "description": "An accessorial service requested in a rate quote query and its outcome in the resulting rate quote.",
        "properties": {
          "code": {
            "description": "The code for the requested accessorial service. A list of accessorial service codes supported by project44 is provided in the API reference data section.",
            "type": "string"
          },
          "status": {
            "description": "The status of the requested accessorial service -- whether or not it is reflected in the total. An outcome of 'ACCEPTED' means the capacity provider accepted the requested accessorial service, included it in their quote total, and provided a charge breakdown. An outcome of 'ACCEPTED_UNITEMIZED' means the capacity provider most likely accepted the requested accessorial service and included it in their quote total, but did not provide a verifiable charge breakdown. An outcome of 'UNACCEPTED' means the capacity provider did not accept the requested accessorial and it is not reflected in the quote total.",
            "enum": [
              "ACCEPTED",
              "ACCEPTED_UNITEMIZED",
              "UNACCEPTED"
            ],
            "type": "string"
          }
        },
        "title": "RequestedAccessorialService",
        "type": "object"
      },
      "RequestorRoleCode": {
        "enum": [
          "Shipper",
          "Consignee",
          "Third Party"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "RolloverDetails": {
        "type": "object",
        "description": "Describes details about rollover events"
      },
      "RouteInfo": {
        "required": [],
        "type": "object",
        "properties": {
          "routeSegments": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteSegment"
            },
            "description": "Contains information about how the shipment moves from each stop to the next."
          },
          "stops": {
            "minItems": 2,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Stop"
            },
            "description": "All stops associated with this shipment."
          }
        },
        "description": "The stops and route for the shipment."
      },
      "RouteSegment": {
        "required": [],
        "type": "object",
        "properties": {
          "fromStopId": {
            "type": "string",
            "description": "The starting stop of this route segment.",
            "format": "uuid"
          },
          "id": {
            "type": "string",
            "description": "The id of this route segment. Will always be populated on response if not provided.",
            "format": "uuid"
          },
          "toStopId": {
            "type": "string",
            "description": "The ending stop of this route segment.",
            "format": "uuid"
          }
        },
        "description": "A portion of the journey through which a shipment is meant to travel,\ndefined by its nodes: the 'to' and 'from' stops."
      },
      "RouteSegmentResponse": {
        "required": [],
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "string",
            "description": "The date which the carrier commits to depart from the route-segment origin.",
            "format": "date"
          },
          "routeSegmentId": {
            "type": "string",
            "description": "The ID of the route-segment.",
            "format": "uuid"
          },
          "toDate": {
            "type": "string",
            "description": "The date which the carrier commits to arrive at the route-segment destination.",
            "format": "date"
          }
        },
        "description": "The carrier-approved dates at which they expect to depart and arrive at each location requested."
      },
      "RouteSegmentWithStops": {
        "required": [],
        "type": "object",
        "properties": {
          "fromStop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Stop"
              }
            ],
            "description": "The starting stop of this route segment."
          },
          "id": {
            "type": "string",
            "description": "The id of this route segment. Will always be populated on response if not provided.",
            "format": "uuid"
          },
          "toStop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Stop"
              }
            ],
            "description": "The ending stop of this route segment."
          }
        },
        "description": "A portion of the journey through which a shipment is meant to travel,\ndefined by its nodes: the 'to' and 'from' stops."
      },
      "SensorContext": {
        "type": "object",
        "properties": {
          "availableSensorTypesWithUnits": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SensorReadingTypeWithUnit"
            }
          }
        },
        "description": "${ShipmentEventHistory.apiModel.sensorContext.value}"
      },
      "SensorReadingTypeWithUnit": {
        "type": "object",
        "properties": {
          "sensorReadingType": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "ZONE1_DOOR",
              "ZONE2_DOOR",
              "ZONE3_DOOR",
              "ZONE4_DOOR",
              "ZONE1_RETURN_AIR_TEMPERATURE",
              "ZONE2_RETURN_AIR_TEMPERATURE",
              "ZONE3_RETURN_AIR_TEMPERATURE",
              "ZONE4_RETURN_AIR_TEMPERATURE",
              "ZONE1_AMBIENT_AIR_TEMPERATURE",
              "ZONE2_AMBIENT_AIR_TEMPERATURE",
              "ZONE3_AMBIENT_AIR_TEMPERATURE",
              "ZONE4_AMBIENT_AIR_TEMPERATURE",
              "ZONE1_SETPOINT_TEMPERATURE",
              "ZONE2_SETPOINT_TEMPERATURE",
              "ZONE3_SETPOINT_TEMPERATURE",
              "ZONE4_SETPOINT_TEMPERATURE"
            ]
          },
          "unit": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "CELSIUS",
              "NO_UNIT"
            ]
          }
        }
      },
      "ServiceLevel": {
        "description": "The service level offered by the capacity provider (e.g., standard or guaranteed).",
        "properties": {
          "code": {
            "description": "The project44 code for this service level.",
            "enum": [
              "STD",
              "EXPEDITE",
              "EXPEDITE17",
              "EXPEDITEAM",
              "GURWIN",
              "GSSING",
              "GSMUL",
              "GSFM",
              "GS8",
              "GS9",
              "GS10",
              "GS11",
              "GSAM",
              "GS14",
              "GS15",
              "GS1530",
              "GUR",
              "ACCELERATED",
              "CAPLOAD",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "description": {
            "description": "A description of this service level, often originating from the capacity provider.",
            "type": "string"
          }
        },
        "title": "ServiceLevel",
        "type": "object"
      },
      "SharingContext": {
        "type": "object",
        "properties": {
          "dataOriginators": {
            "uniqueItems": true,
            "type": "array",
            "description": "This is a list of the tenant(s) that created the shared data, it will be visible on all shared versions of the data.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/DataOriginator"
            }
          },
          "recipients": {
            "uniqueItems": true,
            "type": "array",
            "description": "This is a list of the tenant(s) to whom the data is shared.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/DataRecipient"
            }
          }
        },
        "description": "This model is populated when the data is shared across tenants, it conditionally describes which tenant(s) are involved with the shared data using tenant name and tenant UUID."
      },
      "ShipmentAdditionalField": {
        "type": "object",
        "properties": {
          "keys": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "CUSTOM_ATTRIBUTES",
              "STOPS"
            ]
          }
        },
        "description": "Select non-default fields to return, such as Reference Keys (Custom Attributes)\n\nFor fields like Custom Attributes (Key:Value pairs) only those pairs with keys included in the keys array will be returned\n\nFor non-Custom Attribute AdditionalFields, leaving the keys array empty will return all values\n\nHowever, Custom Attributes must always have keys specified\n\nThe keys array is not a search criterion, it is only used to filter final result columns (not rows)!\n\nGiven a Shipment with ID 1, containing Custom Attributes { A : C } , and { D : E }, searching with a ShipmentSearchCriteria: \n\n(ID EQUALS 1) with AdditionalFields (CUSTOM_ATTRIBUTES, Keys: [ B,D ]\n\nShipment 1 will be returned, but only Custom Attribute {D:E} will come with it.\n\nBecause (ID EQUALS 1) generates a hit for the row, and column {A:C} is omitted by additionalFields."
      },
      "ShipmentApiConfiguration": {
        "description": "Contains fields used to configure the shipment API.",
        "properties": {
          "allowUnsupportedAccessorials": {
            "description": "If set to 'true', accessorial services that are not known to be supported by the capacity provider will be allowed and will be sent through the capacity provider's pickup note API field, according to the shipment note configuration. This is useful when the customer knows that a capacity provider supports an accessorial service that they have not documented, or when the customer has a special agreement with the capacity provider. (default: 'false')",
            "type": "boolean"
          },
          "enableUnitConversion": {
            "description": "If set to 'true', weight and length values in this shipment request will be converted when necessary to the capacity provider's supported units. When 'false', an error will be returned and the shipment will not be placed with the capacity provider if the capacity provider does not support the provided weight and length units. (default: 'false')",
            "type": "boolean"
          },
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          },
          "noteConfiguration": {
            "$ref": "#/components/schemas/ShipmentNoteConfiguration"
          },
          "pickupOnly": {
            "description": "If set to 'true', will not request a BOL for this shipment, and will only transmit pickup information to the carrier. Cannot be requested with 'PrescheduledPickup'. (default: 'false')",
            "type": "boolean"
          },
          "preScheduledPickup": {
            "description": "If set to 'true', will identify the pickup for this shipment as being already scheduled, and will only transmit BOL information to the carrier. Cannot be requested with 'PickupOnly'. (default: 'false')",
            "type": "boolean"
          }
        },
        "title": "ShipmentApiConfiguration",
        "type": "object"
      },
      "ShipmentAttribute": {
        "description": "Contains a key and value for custom attributes.",
        "properties": {
          "name": {
            "description": "The name for an attribute. Must be unique.",
            "type": "string"
          },
          "predefined": {
            "type": "boolean"
          },
          "value": {
            "description": "The value for an attribute.",
            "type": "string"
          },
          "values": {
            "description": "The values for an attribute.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "ShipmentAttribute",
        "type": "object"
      },
      "ShipmentAttributeDefinition": {
        "description": "Name of an attribute to be defined",
        "properties": {
          "name": {
            "description": "The name for an attribute. Must be unique.",
            "type": "string"
          }
        },
        "title": "ShipmentAttributeDefinition",
        "type": "object"
      },
      "ShipmentAttributeDefinitionCollection": {
        "description": "An attribute that has been defined via the provided endpoint",
        "properties": {
          "shipmentAttributeDefinitions": {
            "description": "A list of objects each containing the name of an attribute",
            "items": {
              "$ref": "#/components/schemas/ShipmentAttributeDefinition"
            },
            "type": "array"
          }
        },
        "title": "ShipmentAttributeDefinitionCollection",
        "type": "object"
      },
      "ShipmentAttributeDefinitionConfirmation": {
        "description": "Name of an attribute that has been predefined through the api/v4/shipmentattributedefinitions endpoint",
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipmentAttributeDefinition": {
            "$ref": "#/components/schemas/ShipmentAttributeDefinition"
          }
        },
        "title": "ShipmentAttributeDefinitionConfirmation",
        "type": "object"
      },
      "ShipmentAttributeFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string"
          },
          "operator": {
            "type": "string",
            "description": "If values is not populated, the CONTAINS operator is not supported.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the names and values of custom attributes.\n\nAttributes are tenant-defined and each attribute may have multiple values. An attribute can result in a match if any of its values match the criteria.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the type and values, and they are combined using an AND operator.\n\nExample: \n\n(attributes.name EQUALS X AND any attributes.values EQUALS [A OR B OR C]) AND \n\n(attributes.name EQUALS Y AND any attributes.values EQUALS [D OR F])"
      },
      "ShipmentContent": {
        "type": "object",
        "properties": {
          "minTemperatureThreshold": {
            "type": "number",
            "format": "float"
          },
          "maxTemperatureThreshold": {
            "type": "number",
            "format": "float"
          },
          "productCategory": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "FROZEN_FOOD",
              "REFRIGERATED_FOOD",
              "HOT_PREPARED_FOODS",
              "FRESH_MEAT_AND_POULTRY",
              "FROZEN_MEAT_AND_SEAFOOD",
              "FRESH_SEAFOOD",
              "DAIRY_PRODUCTS",
              "FROZEN_DAIRY",
              "FRESH_PRODUCE",
              "TROPICAL_FRUITS_AND_VEGETABLES",
              "ROOT_VEGETABLES",
              "WATERMELONS_AND_CUCUMBERS",
              "VACCINES_AND_BIOLOGICS",
              "ULTRA_COLD_STORAGE_VACCINES",
              "BLOOD_AND_PLASMA_PRODUCTS",
              "STERILE_INJECTABLE_MEDICATIONS",
              "DIAGNOSTIC_KITS_AND_MEDICAL_TESTING_EQUIPMENT",
              "LITHIUM_ION_BATTERIES",
              "SEMICONDUCTORS_AND_MICROCHIPS",
              "RUBBER_AND_POLYMER_BASED_AUTO_PARTS",
              "FRESH_CUT_FLOWERS",
              "TROPICAL_FLOWERS"
            ]
          },
          "shipperTemperatureSetPoint": {
            "type": "number",
            "format": "float"
          },
          "truckloadZones": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "UNKNOWN",
                "ZONE1",
                "ZONE2",
                "ZONE3",
                "ZONE4"
              ]
            }
          },
          "thresholdDurationMinutes": {
            "type": "integer",
            "format": "int32"
          }
        },
        "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments."
      },
      "ShipmentCount": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "format": "int64"
          }
        },
        "description": "Contains information about the count of shipments which match some criteria."
      },
      "ShipmentDateFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "description": "The tail end of an absolute time window.",
            "format": "date-time"
          },
          "offsetMinutes": {
            "type": "integer",
            "description": "Used to construct relative ranges where negative offset indicates time before startDateTime or Now and positive offset indicates time after startDateTime or Now.",
            "format": "int64"
          },
          "operator": {
            "type": "string",
            "enum": [
              "WITHIN",
              "ON_OR_BEFORE",
              "ON_OR_AFTER"
            ]
          },
          "relativeDateTimeWindow": {
            "type": "string",
            "description": "A sliding window that matches to common time definitions like \"today\" or \"tomorrow\".",
            "enum": [
              "YESTERDAY",
              "TODAY",
              "TOMORROW",
              "LAST_WEEK",
              "THIS_WEEK",
              "NEXT_WEEK",
              "THIS_MONTH",
              "LAST_MONTH",
              "NEXT_MONTH"
            ]
          },
          "relativeWindowTimeZoneOffset": {
            "type": "object",
            "properties": {
              "totalSeconds": {
                "type": "integer",
                "format": "int32"
              },
              "id": {
                "type": "string"
              },
              "rules": {
                "type": "object",
                "properties": {
                  "fixedOffset": {
                    "type": "boolean"
                  },
                  "transitions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "instant": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "duration": {
                          "type": "object",
                          "properties": {
                            "seconds": {
                              "type": "integer",
                              "format": "int64"
                            },
                            "zero": {
                              "type": "boolean"
                            },
                            "nano": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "negative": {
                              "type": "boolean"
                            },
                            "units": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "durationEstimated": {
                                    "type": "boolean"
                                  },
                                  "timeBased": {
                                    "type": "boolean"
                                  },
                                  "dateBased": {
                                    "type": "boolean"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "gap": {
                          "type": "boolean"
                        },
                        "dateTimeAfter": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "dateTimeBefore": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "overlap": {
                          "type": "boolean"
                        }
                      }
                    }
                  },
                  "transitionRules": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "month": {
                          "type": "string",
                          "enum": [
                            "JANUARY",
                            "FEBRUARY",
                            "MARCH",
                            "APRIL",
                            "MAY",
                            "JUNE",
                            "JULY",
                            "AUGUST",
                            "SEPTEMBER",
                            "OCTOBER",
                            "NOVEMBER",
                            "DECEMBER"
                          ]
                        },
                        "timeDefinition": {
                          "type": "string",
                          "enum": [
                            "UTC",
                            "WALL",
                            "STANDARD"
                          ]
                        },
                        "standardOffset": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "dayOfWeek": {
                          "type": "string",
                          "enum": [
                            "MONDAY",
                            "TUESDAY",
                            "WEDNESDAY",
                            "THURSDAY",
                            "FRIDAY",
                            "SATURDAY",
                            "SUNDAY"
                          ]
                        },
                        "dayOfMonthIndicator": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "localTime": {
                          "$ref": "#/components/schemas/LocalTime"
                        },
                        "midnightEndOfDay": {
                          "type": "boolean"
                        }
                      }
                    }
                  }
                }
              }
            },
            "description": "The timezone offset of the relativeDateTimeWindow."
          },
          "startDateTime": {
            "type": "string",
            "description": "The beginning of an absolute time window (if endDateTime is populated) or the anchor of a relative offset window (if offsetMinutes is populated).",
            "format": "date-time"
          },
          "types": {
            "type": "array",
            "description": "The types of dates to filter on. At least one type must be provided. If multiple types are provided, then any of the corresponding dates may match the filter.",
            "items": {
              "type": "string",
              "description": "The types of dates to filter on. At least one type must be provided. If multiple types are provided, then any of the corresponding dates may match the filter.",
              "enum": [
                "CREATED_DATE_TIME",
                "LAST_MODIFIED_DATE_TIME",
                "COMPLETED_DATE_TIME"
              ]
            }
          }
        },
        "description": "Match shipments based on date times (such as created date time or last updated date time), relative to a target range.\n\nWhen operator is ON_OR_AFTER, NOW + offsetMinutes or the startDateTime is used as the date\n\nWhen operator is ON_OR_BEFORE, NOW + offsetMinutes or the endDateTime is used as the date.\n\nConstruct absolute ranges with both startDateTime and endDateTime with null offsetMinutes\n\nConstruct relative ranges with offsetMinutes, where negative offset indicates time before Now and positive offset indicates time after Now\n\nSearch sliding windows with constant size with relativeDateTimeWindow, supports common sense time definitions like TODAY and THIS WEEK, does not combine with the absolute operands (startDateTime + endDateTime)\n\nExample: Now and the following 10 days => offsetMinutes: 14400 operator: WITHIN\n\nExample: The last 5 hours: offsetMinutes: -300 operator: WITHIN\n\nExample: Before 8 hours from now: offsetMinutes: 480 operator: ON_OR_BEFORE"
      },
      "ShipmentDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable to your shipment which may be noteworthy to the carrier."
          },
          "deliveryStopId": {
            "type": "string",
            "description": "The unique ID for the location where the handling unit should be delivered.",
            "format": "uuid"
          },
          "description": {
            "type": "string",
            "description": "Free text space to describe the handling unit."
          },
          "handlingUnits": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/HandlingUnitsDetails"
              },
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/BookingHandlingUnit"
                }
              }
            ],
            "description": "The way in which items from this Load are being transported. It is suggested to use Array of BookingHandlingUnit (objects) while HandlingUnitsDetails (object) is going to be deprecated."
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Item"
            },
            "description": "The items for this shipment details, if applicable.",
            "deprecated": true
          },
          "identifiers": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "description": "The identifiers that can identify this load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as `PURCHASE_ORDER`."
          },
          "loadId": {
            "type": "string",
            "description": "The unique project44-generated id of the load. Not to be provided on booking creation. Once `BOOKED`, the booking initiates a load within project44. With this identifier, the shipper may seek the trackable Load through the rest of the project44 platform.",
            "format": "uuid"
          },
          "pickupStopId": {
            "type": "string",
            "description": "The unique ID for the location where the handling unit should be picked up.",
            "format": "uuid"
          }
        },
        "description": "Information which describes the entities being transported.\nComprised of items, this is a single definition of the item(s)\nto be picked up and delivered at a relevant stop."
      },
      "ShipmentDurationFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "durationCriteria": {
            "type": "array",
            "description": "The criteria which must be met by the targeted duration(s). Criteria are ANDed together.",
            "items": {
              "$ref": "#/components/schemas/TimeDurationCriterion"
            }
          },
          "types": {
            "type": "array",
            "description": "The types of durations against which to apply the criteria. Types are ORed together.",
            "items": {
              "type": "string",
              "description": "The types of durations against which to apply the criteria. Types are ORed together.",
              "enum": [
                "ACTUAL_TRANSIT_TIME",
                "ESTIMATED_TRANSIT_TIME",
                "ACTUAL_OR_ESTIMATED_TRANSIT_TIME"
              ]
            }
          }
        },
        "description": "Match shipments which contain one or more durations that meet all criteria. Criteria are ANDed together, types are ORed together.\n\nExample: (estimated transit time >= 30 minutes AND < 1 day) AND (actual transit time does not exist)\n\nExample: (duration X OR duration Y >= 30 minutes) AND (duration Z < 3 hours)"
      },
      "ShipmentEventDateCriterion": {
        "required": [],
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "description": "The tail end of an absolute time window.",
            "format": "date-time"
          },
          "offsetMinutes": {
            "type": "integer",
            "description": "Used to construct relative ranges where negative offset indicates time before startDateTime or Now and positive offset indicates time after startDateTime or Now.",
            "format": "int64"
          },
          "operator": {
            "type": "string",
            "enum": [
              "WITHIN",
              "ON_OR_BEFORE",
              "ON_OR_AFTER"
            ]
          },
          "relativeDateTimeWindow": {
            "type": "string",
            "description": "A sliding window that matches to common time definitions like \"today\" or \"tomorrow\".",
            "enum": [
              "YESTERDAY",
              "TODAY",
              "TOMORROW",
              "LAST_WEEK",
              "THIS_WEEK",
              "NEXT_WEEK",
              "THIS_MONTH",
              "LAST_MONTH",
              "NEXT_MONTH"
            ]
          },
          "relativeWindowTimeZoneOffset": {
            "type": "object",
            "properties": {
              "totalSeconds": {
                "type": "integer",
                "format": "int32"
              },
              "id": {
                "type": "string"
              },
              "rules": {
                "type": "object",
                "properties": {
                  "fixedOffset": {
                    "type": "boolean"
                  },
                  "transitions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "instant": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "duration": {
                          "type": "object",
                          "properties": {
                            "seconds": {
                              "type": "integer",
                              "format": "int64"
                            },
                            "zero": {
                              "type": "boolean"
                            },
                            "nano": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "negative": {
                              "type": "boolean"
                            },
                            "units": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "durationEstimated": {
                                    "type": "boolean"
                                  },
                                  "timeBased": {
                                    "type": "boolean"
                                  },
                                  "dateBased": {
                                    "type": "boolean"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "gap": {
                          "type": "boolean"
                        },
                        "dateTimeAfter": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "dateTimeBefore": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "overlap": {
                          "type": "boolean"
                        }
                      }
                    }
                  },
                  "transitionRules": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "month": {
                          "type": "string",
                          "enum": [
                            "JANUARY",
                            "FEBRUARY",
                            "MARCH",
                            "APRIL",
                            "MAY",
                            "JUNE",
                            "JULY",
                            "AUGUST",
                            "SEPTEMBER",
                            "OCTOBER",
                            "NOVEMBER",
                            "DECEMBER"
                          ]
                        },
                        "timeDefinition": {
                          "type": "string",
                          "enum": [
                            "UTC",
                            "WALL",
                            "STANDARD"
                          ]
                        },
                        "standardOffset": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetBefore": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "offsetAfter": {
                          "type": "object",
                          "properties": {
                            "totalSeconds": {
                              "type": "integer",
                              "format": "int32"
                            },
                            "id": {
                              "type": "string"
                            }
                          }
                        },
                        "dayOfWeek": {
                          "type": "string",
                          "enum": [
                            "MONDAY",
                            "TUESDAY",
                            "WEDNESDAY",
                            "THURSDAY",
                            "FRIDAY",
                            "SATURDAY",
                            "SUNDAY"
                          ]
                        },
                        "dayOfMonthIndicator": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "localTime": {
                          "$ref": "#/components/schemas/LocalTime"
                        },
                        "midnightEndOfDay": {
                          "type": "boolean"
                        }
                      }
                    }
                  }
                }
              }
            },
            "description": "The timezone offset of the relativeDateTimeWindow."
          },
          "startDateTime": {
            "type": "string",
            "description": "The beginning of an absolute time window (if endDateTime is populated) or the anchor of a relative offset window (if offsetMinutes is populated).",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "description": "The type of date on the event that should be searched.",
            "enum": [
              "PLANNED_DATETIME",
              "PLANNED_END_DATETIME",
              "INITIAL_PLANNED_DATETIME",
              "INITIAL_PLANNED_END_DATETIME",
              "CARRIER_INITIAL_PLANNED_DATETIME",
              "CARRIER_INITIAL_PLANNED_END_DATETIME",
              "CARRIER_LATEST_PLANNED_DATETIME",
              "CARRIER_LATEST_PLANNED_END_DATETIME",
              "CUSTOMER_INITIAL_PLANNED_DATETIME",
              "CUSTOMER_INITIAL_PLANNED_END_DATETIME",
              "CUSTOMER_LATEST_PLANNED_DATETIME",
              "CUSTOMER_LATEST_PLANNED_END_DATETIME",
              "ESTIMATED_DATETIME",
              "ACTUAL_DATETIME",
              "ACTUAL_OR_ESTIMATED_DATETIME"
            ]
          }
        },
        "description": "Match shipments based on the datetimes of their events, relative to a target range.\n\nWhen operator is ON_OR_AFTER, NOW + offsetMinutes or the startDateTime is used as the date\n\nWhen operator is ON_OR_BEFORE, NOW + offsetMinutes or the endDateTime is used as the date.\n\nConstruct absolute ranges with both startDateTime and endDateTime with null offsetMinutes\n\nConstruct relative ranges with offsetMinutes, where negative offset indicates time before Now and positive offset indicates time after Now\n\nSearch sliding windows with constant size with relativeDateTimeWindow, supports common sense time definitions like TODAY and THIS WEEK, does not combine with the absolute operands (startDateTime + endDateTime)\n\nExample: Now and the following 10 days => offsetMinutes: 14400 operator: WITHIN\n\nExample: The last 5 hours: offsetMinutes: -300 operator: WITHIN\n\nExample: Before 8 hours from now: offsetMinutes: 480 operator: ON_OR_BEFORE"
      },
      "ShipmentEventDeltaCriterion": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS, LESS_THAN, and MORE_THAN operators are supported for this criterion.",
            "enum": [
              "MORE_THAN",
              "MORE_THAN_OR_EQUALS",
              "LESS_THAN",
              "LESS_THAN_OR_EQUALS",
              "EQUALS",
              "NOT_EQUALS",
              "EXISTS",
              "NOT_EXISTS"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "RUNNING_EARLY",
              "RUNNING_LATE",
              "OCCURRED_EARLY",
              "OCCURRED_LATE",
              "OCCURRED_EARLY_OR_RUNNING_EARLY",
              "OCCURRED_LATE_OR_RUNNING_LATE"
            ]
          },
          "value": {
            "minimum": 0,
            "type": "integer",
            "format": "int64"
          }
        },
        "description": "Match shipments based on each shipment's delta between planned datetime and estimated datetime, or delta between planned datetime and actual datetime.\n\nThe value is represented in minutes and must be non-negative.\n\nRUNNING_EARLY implies that the estimated datetime is before the planned datetime\n\nRUNNING_LATE implies that the estimated datetime is after the planned datetime\n\nOCCURRED_EARLY implies that the actual datetime is before the planned datetime\n\nOCCURRED_LATE implies that the actual datetime is after the planned datetime\n\nEvents which are estimated to occur or have occurred on time can be queried using EQUALS 0 minutes. Note that this matches only shipments which are on time for that event. For example, RUNNING_LATE with EQUALS 0 minutes will match on-time shipments, but will not match shipments that are running early.\n\nExample: event OCCURRED_EARLY by LESS_THAN 60 minutes\n\nExample: event RUNNING_LATE by MORE_THAN 1440 minutes (1 day)"
      },
      "ShipmentEventDescriptionCriterion": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the value of events' descriptions.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: \n\n(event.description EQUALS [A OR B OR C]) AND \n\n(event.description EQUALS [D OR F])"
      },
      "ShipmentEventDetails": {
        "type": "object",
        "properties": {
          "qualityControl": {
            "$ref": "#/components/schemas/QualityControlEventDetails"
          }
        },
        "description": "Contains accompanying information about the event, such as quality control codes."
      },
      "ShipmentEventFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "dateRanges": {
            "type": "array",
            "description": "Each item in this array should represent a distinct date type (planned, estimated, etc.)\n\nCriteria within this array are combined using an AND operator.",
            "items": {
              "$ref": "#/components/schemas/ShipmentEventDateCriterion"
            }
          },
          "deltas": {
            "type": "array",
            "description": "Each item in this array should represent a distinct delta type (running early, occurred late, etc.)\n\nCriteria within this array are combined using an AND operator.",
            "items": {
              "$ref": "#/components/schemas/ShipmentEventDeltaCriterion"
            }
          },
          "descriptions": {
            "type": "array",
            "description": "Each item in this array should represent a distinct event description\n\nCriteria within this array are combined using an AND operator.",
            "items": {
              "$ref": "#/components/schemas/ShipmentEventDescriptionCriterion"
            }
          },
          "stopProperties": {
            "type": "array",
            "description": "This criteria applies against the stop location associated with the event.",
            "items": {
              "$ref": "#/components/schemas/LocationCriterion"
            }
          },
          "stopIdentifiers": {
            "type": "array",
            "description": "This criteria applies against the stop location associated with the event.",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifierCriterion"
            }
          },
          "stopType": {
            "$ref": "#/components/schemas/StopTypeCriterion"
          },
          "scopes": {
            "type": "array",
            "description": "If multiple scopes are provided, they will be combined using OR boolean logic.",
            "items": {
              "type": "string",
              "description": "If multiple scopes are provided, they will be combined using OR boolean logic.",
              "enum": [
                "LATEST_ACTUAL_EVENT",
                "ANY_EVENT"
              ]
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "TRACKING_INITIATE",
              "TRACKING_START",
              "ARRIVAL_AT_STOP",
              "DEPARTURE_FROM_STOP",
              "LOAD_ONTO_VEHICLE",
              "UNLOAD_FROM_VEHICLE",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_END_BY_USER",
              "TRACKING_COMPLETE",
              "GATE_IN",
              "GATE_OUT",
              "FLIGHT_BOOKING",
              "MANIFEST",
              "RECEIVE_FROM_SHIPPER",
              "CONSIGNEE_NOTIFY",
              "DELIVERY",
              "WARNING",
              "EXCEPTION",
              "TRACKING_STOP",
              "EXCEPTION_LATE_DEPARTURE",
              "EXCEPTION_MISSED_CONNECTION",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT_FULL",
              "LOAD",
              "DISCHARGE",
              "EXCEPTION_DELAYED",
              "EXCEPTION_DELIVERY_MISSED",
              "EXCEPTION_HELD",
              "EXCEPTION_PICKUP_MISSED",
              "AVAILABLE",
              "ENTERED_GEOFENCE",
              "EXITED_GEOFENCE",
              "INFO",
              "OUT_FOR_DELIVERY",
              "PICKED_UP",
              "RETURN_TO_SENDER",
              "TRACKING_FAILED",
              "UNAUTHORIZED",
              "PICKUP_MISSED",
              "SURVEY",
              "HELD",
              "RELEASE",
              "DELAYED",
              "DELIVERY_MISSED",
              "ENTERED_INNER_GEOFENCE",
              "EXITED_INNER_GEOFENCE",
              "ENTERED_OUTER_GEOFENCE",
              "EXITED_OUTER_GEOFENCE",
              "ENTERED_FINAL_GEOFENCE",
              "EXITED_FINAL_GEOFENCE",
              "IDLE",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "DISPATCH",
              "CUSTOMS_HOLD",
              "CUSTOMS_CLEARANCE",
              "CUSTOMS_DOCS_FILING",
              "CUSTOMS_TRANSIT_DOCS_ISSUED",
              "CUSTOMS_TRANSIT_DOCS_CLOSED",
              "CARRIER_HOLD",
              "RECEIVE_FROM_CARRIER",
              "ISSUE_FREIGHT_BILL",
              "FREIGHT_ON_HAND",
              "READY_FOR_CARRIAGE",
              "LAST_FREE_DAY",
              "MISSING_CARRIER",
              "STUFF",
              "STRIP",
              "SEAL_INSPECTION",
              "SEAL_REMOVAL",
              "SEAL_RESEAL",
              "HANDOVER",
              "DOCUMENT_ADD",
              "DOCUMENT_REMOVE",
              "REMOVE_FROM_BOOKING",
              "COST_UPDATE",
              "SHARING_STOPPED",
              "ROLLED_OVER",
              "BAD_ORDER",
              "BAD_ORDER_RELEASE"
            ]
          }
        },
        "description": "Match shipments using a collection of event-related criteria. All provided criteria within are combined using an AND operator."
      },
      "ShipmentEventHistory": {
        "type": "object",
        "properties": {
          "costs": {
            "type": "array",
            "description": "All costs incurred for this shipment and the assets contained within.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentCost"
            }
          },
          "contents": {
            "type": "array",
            "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/ShipmentContent"
            }
          },
          "events": {
            "type": "array",
            "description": "All events that occurred for this shipment. Will always be in ascending order by the date the event occurred.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentEvent"
            }
          },
          "exceptions": {
            "type": "array",
            "description": "${ShipmentEventHistory.apiModel.exceptions.value}",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/ShipmentException"
            }
          },
          "shipment": {
            "$ref": "#/components/schemas/TrackedShipment"
          },
          "states": {
            "type": "array",
            "description": "All states that the shipment was or currently is in. Order is not guaranteed.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentState"
            }
          },
          "sharingContext": {
            "$ref": "#/components/schemas/SharingContext"
          },
          "sensorContext": {
            "$ref": "#/components/schemas/SensorContext"
          }
        },
        "description": "The history of everything that has occurred for the shipment during tracking."
      },
      "ShipmentException": {
        "required": [],
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "To represent buckets of exceptions within a category. These will be visible in the UI when we display aggregated exceptions.",
            "enum": [
              "UNKNOWN",
              "NO_TRACKING_METHOD",
              "RUNNING_LATE",
              "HOLD",
              "ROUTING",
              "ASSET",
              "DELIVERY",
              "TRACKING",
              "VISIBILITY_FREIGHT_FORWARDER",
              "VISIBILITY_AIRLINE",
              "VISIBILITY_GEOPOSITION_AGGREGATOR",
              "SENSOR",
              "TRANSPORTATION",
              "WEATHER",
              "NATURAL_DISASTER",
              "REGULATION",
              "STRIKE",
              "PUBLIC_SAFETY",
              "ACCIDENT",
              "CYBER",
              "INFRASTRUCTURE",
              "HAZARD",
              "GEOPOLITICAL",
              "WAR",
              "HEALTH",
              "HOLIDAYS",
              "PRODUCTION",
              "VISIBILITY_NO_TRACKING_METHODS",
              "VISIBILITY_API_PUSH",
              "VISIBILITY_API_PULL",
              "VISIBILITY_TELEMATICS",
              "VISIBILITY_APP",
              "DWELL"
            ]
          },
          "definitionId": {
            "type": "string",
            "description": "A reference to the definition of the exception. Every ExceptionDefinition contains a logic which determines how the exception would be derived.",
            "format": "uuid"
          },
          "namespace": {
            "type": "string",
            "description": "Represents different classes of exceptions",
            "enum": [
              "UNKNOWN",
              "TRUCKLOAD_TRACKING",
              "P44_DETECTED",
              "CARRIER_REPORTED",
              "ROOT_CAUSE_ANALYSIS",
              "DISRUPTION"
            ]
          },
          "reason": {
            "type": "string",
            "description": "A code to identify the actual unit exception. This is the most granular enumeration to identify an exception.",
            "enum": [
              "UNKNOWN",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "TRACKING_METHOD_IDENTIFIER_MISMATCH",
              "UNKNOWN_VEHICLE_IDENTIFIER",
              "INVALID_EQUIPMENT_IDENTIFIER",
              "INVALID_PHONE_NUMBER",
              "ALL_SHORT",
              "REFUSED_DELIVERY",
              "BAD_ORDER",
              "CONTAINER_ROLLED",
              "SPLIT_FLIGHT",
              "SHIPMENT_HELD",
              "LATE_TO_CARRIER_PLANNED",
              "BOOKING_UPDATED",
              "MISSED_CONNECTION",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "FFW_NOT_SUPPORTED",
              "FFW_AUTHENTICATION_ERROR",
              "FFW_API_UNAVAILABLE",
              "UNSUPPORTED_AIRLINE",
              "INVALID_FLIGHT_NUMBER",
              "UNABLE_TO_SELECT_FLIGHT",
              "NO_POSITION_DATA_FOR_FLIGHT",
              "MULTIHOP_FLIGHT_UNKNOWN_LOCATION",
              "NO_DATA_FOR_AWB",
              "INVALID_HAWB",
              "FFW_NOT_ENABLED_FOR_TENANT",
              "TEMPERATURE_BREACHED",
              "TRANSPORTATION_RISK",
              "WEATHER_ALERT",
              "NATURAL_DISASTER_ALERT",
              "REGULATORY_RISK",
              "WORKER_STRIKE",
              "PUBLIC_SAFETY_RISK",
              "ACCIDENT_ALERT",
              "CYBER_RISK",
              "INFRA_RISK",
              "FIRE_AND_HAZARD",
              "POLITICAL_RISK",
              "WAR_RISK",
              "HEALTH_AND_DISEASE",
              "HOLIDAY_DELAYS",
              "SHUTDOWN_RISK",
              "CARRIER_DOES_NOT_HAVE_CONFIGURED_TRACKING_METHODS",
              "MISSING_PHONE_NUMBER",
              "SHIPMENT_INITIATION_FAILED",
              "CARRIER_NOT_ONBOARDED_FOR_TENANT",
              "DRIVER_ONBOARDING_INCOMPLETE",
              "UNSUCCESSFUL_SHIPMENT_FETCH_USING_APP",
              "LOCATION_ACCESS_INSUFFICIENT",
              "ONBOARDING_VERIFICATION_SMS_FAILED",
              "SHIPMENT_INVITE_SMS_FAILED",
              "VOIP_PHONE_NUMBER_ASSIGNED",
              "DRIVER_DENIED_TERMS_AND_CONDITIONS",
              "DRIVER_UNSUBSCRIBED_SMS_NOTIFICATION",
              "DRIVER_DENIED_LOCATION_ACCESS",
              "APP_CONFIRM_CODE_INVALID",
              "DWELL_AT_STOP",
              "VEHICLE_NEVER_ENTERED_GEOFENCE",
              "VEHICLE_NOT_FOUND",
              "NO_STATUS_UPDATES",
              "NO_TRACKING_DATA_FROM_VEHICLE",
              "IDENTIFIER_TYPE_MISMATCH_FOR_ONBOARDED_CARRIER",
              "NO_HISTORICAL_CARRIER_TRACKING",
              "NO_CARRIER_TRACKING_USING_API_FOR_TENANT",
              "NO_CARRIER_TRACKING_USING_API",
              "IMPORT_DWELL_TIME",
              "IMPORT_DEMURRAGE_RISK",
              "IMPORT_DETENTION_RISK"
            ]
          },
          "status": {
            "type": "string",
            "description": "Represents current state of an exception. <br><br>ACTIVE- The shipment currently matches the exception criteria <br>RESOLVED- The exception was active on this shipment and has been resolved."
          },
          "transportationMode": {
            "type": "string",
            "description": "Transportation Mode on which the exception is assigned to",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ]
          },
          "timeline": {
            "minItems": 1,
            "type": "array",
            "description": "The timeline of the exception being applicable on the shipment. This object timeframes the status transitions.",
            "items": {
              "$ref": "#/components/schemas/ShipmentExceptionInstance"
            }
          }
        },
        "description": "Exception is a recorded fact that something is going wrong or went wrong along the shipment journey"
      },
      "ShipmentExceptionInstance": {
        "required": [],
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "A human-readable understanding of the exception"
          },
          "detail": {
            "$ref": "#/components/schemas/ExceptionDetail"
          },
          "endDateTime": {
            "type": "string",
            "description": "DateTime when the shipment exited out of the exception matching criteria.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "ID of the exception instance.",
            "format": "uuid"
          },
          "startDateTime": {
            "type": "string",
            "description": "DateTime when the shipment started matching the exception criteria.",
            "format": "date-time"
          }
        },
        "description": "The timeframed instance of the exception being applicable on the shipment."
      },
      "ShipmentExceptionSummary": {
        "required": [],
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "To represent buckets of exceptions within a category. These will be visible in the UI when we display aggregated exceptions.",
            "enum": [
              "UNKNOWN",
              "NO_TRACKING_METHOD",
              "RUNNING_LATE",
              "HOLD",
              "ROUTING",
              "ASSET",
              "DELIVERY",
              "TRACKING"
            ]
          },
          "definitionId": {
            "type": "string",
            "description": "A reference to the definition of the exception. Every ExceptionDefinition contains a logic which determines how the exception would be derived.",
            "format": "uuid"
          },
          "namespace": {
            "type": "string",
            "description": "Represents different classes of exceptions.",
            "enum": [
              "UNKNOWN",
              "TRUCKLOAD_TRACKING",
              "P44_DETECTED",
              "CARRIER_REPORTED",
              "ROOT_CAUSE_ANALYSIS"
            ]
          },
          "reason": {
            "type": "string",
            "description": "A code to identify the actual unit exception. This is the most granular enumeration to identify an exception.",
            "enum": [
              "UNKNOWN",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "TRACKING_METHOD_IDENTIFIER_MISMATCH",
              "UNKNOWN_VEHICLE_IDENTIFIER",
              "INVALID_EQUIPMENT_IDENTIFIER",
              "INVALID_PHONE_NUMBER",
              "ALL_SHORT",
              "REFUSED_DELIVERY",
              "BAD_ORDER",
              "CONTAINER_ROLLED",
              "SPLIT_FLIGHT",
              "SHIPMENT_HELD",
              "LATE_TO_CARRIER_PLANNED",
              "BOOKING_UPDATED",
              "MISSED_CONNECTION",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "FFW_NOT_SUPPORTED",
              "FFW_AUTHENTICATION_ERROR",
              "FFW_API_UNAVAILABLE",
              "UNSUPPORTED_AIRLINE",
              "INVALID_FLIGHT_NUMBER",
              "UNABLE_TO_SELECT_FLIGHT",
              "NO_POSITION_DATA_FOR_FLIGHT",
              "MULTIHOP_FLIGHT_UNKNOWN_LOCATION",
              "NO_DATA_FOR_AWB",
              "INVALID_HAWB",
              "FFW_NOT_ENABLED_FOR_TENANT"
            ]
          },
          "status": {
            "type": "string",
            "description": "Represents current state of an exception.\nACTIVE- The shipment currently matches the exception criteria.\nRESOLVED- The exception was active on this shipment and has been resolved."
          },
          "startDateTime": {
            "type": "string",
            "description": "DateTime when the shipment started matching the exception criteria.",
            "format": "date-time"
          },
          "transportationMode": {
            "type": "string",
            "description": "Transportation Mode on which the exception is assigned to.",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ]
          }
        },
        "description": "A brief overview of a shipment exception, including its definition and current status."
      },
      "ShipmentIdentifier": {
        "description": "Shipment Identifier pair that contains the type and the value.",
        "properties": {
          "type": {
            "description": "The type of the identifier.",
            "enum": [
              "AIR_WAYBILL",
              "BILL_OF_LADING",
              "BOOKING_NUMBER",
              "CARRIER_IATA",
              "CARRIER_ICAO",
              "CARRIER_NAME",
              "CARRIER_SCAC",
              "CONTAINER_ID",
              "CUSTOMER_REFERENCE",
              "DELIVERY_NUMBER",
              "EXTERNAL",
              "FLIGHT_NUMBER",
              "ORDER",
              "PICKUP",
              "PRO",
              "PURCHASE_ORDER",
              "RAIL_CAR_ID",
              "RAIL_WAYBILL",
              "TRACKING_NUMBER",
              "TRAILER_ID",
              "UNKNOWN",
              "VESSEL_IMO",
              "VESSEL_NAME",
              "WAYBILL"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the identifier.",
            "type": "string"
          }
        },
        "title": "ShipmentIdentifier",
        "type": "object"
      },
      "ShipmentIdentifierFilter": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "If values is not populated, only the EQUALS operator is supported.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "scopes": {
            "type": "array",
            "description": "If multiple scopes are provided, they will be combined using OR boolean logic.",
            "items": {
              "type": "string",
              "description": "Specifies which field(s) the filter should apply against. If not specified, the default scope is `SHIPMENT`.\n\n`SHIPMENT` - Filter applies against identifiers at the shipment level as well as at the segment level.\n\n`CURRENT_SEGMENT` - Filter applies only against identifiers in the active route segment.\n\n`PRIMARY` - Filter applies only against the primary identifier. The primary identifier is a shipment-level identifier which is intended to most uniquely refer to a shipment; it is derived based on a hierarchy of identifier types.",
              "enum": [
                "SHIPMENT",
                "CURRENT_SEGMENT",
                "PRIMARY"
              ]
            }
          },
          "types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifierTypeEnum"
            }
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "description": "Match shipments based on the type and value of the identifiers.\n\nThis criterion will be checked against the identifiers at the shipment level as well as at the segment level; if either satisfies the criterion, the shipment is considered a match.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nFor each item, filters are generated for both the type and values, and they are combined using an AND operator.\n\nExample: \n\n(identifier.types EQUALS [X OR Y] AND identifier.values EQUALS [A OR B])\n\nThis will generate a hit for Type: X and Value: B, but not Type: X and Value: C"
      },
      "ShipmentImage": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerAccount": {
            "$ref": "#/components/schemas/CustomerAccount"
          },
          "documentType": {
            "description": "A code for this image's document type.",
            "enum": [
              "BILL_OF_LADING",
              "DELIVERY_RECEIPT",
              "WEIGHT_CERTIFICATE",
              "INVOICE",
              "INSPECTION_CERTIFICATE",
              "LETTER_OF_AUTHORIZATION",
              "LUMPER_CERTIFICATE",
              "PACKING_SLIP"
            ],
            "type": "string"
          },
          "imageFormat": {
            "description": "A code for this image's format.",
            "enum": [
              "PDF",
              "TIF",
              "PNG",
              "GIF",
              "JPG"
            ],
            "type": "string"
          },
          "imagePages": {
            "description": "Images of the pages that comprise a document (min:1, max:25).",
            "items": {
              "$ref": "#/components/schemas/ShipmentImagePage"
            },
            "type": "array"
          }
        },
        "title": "ShipmentImage",
        "type": "object"
      },
      "ShipmentImagePage": {
        "properties": {
          "imageData": {
            "description": "The Base64 encoded image contents. This or imageUrl may be populated but not both.",
            "type": "string"
          },
          "imageUrl": {
            "description": "The web URL for accessing this image. This or imageData may be populated but not both.",
            "type": "string"
          },
          "pageNumber": {
            "description": "The index of the image page in the list of image pages that comprise a document for the shipment.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "ShipmentImagePage",
        "type": "object"
      },
      "ShipmentInternalIdFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "values": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "description": "Match shipments based on their internal IDs.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (id EQUALS [A OR B OR C])\n\nExample: (id NOT_EQUALS A) AND (id NOT_EQUALS B)"
      },
      "ShipmentMilestone": {
        "required": [],
        "type": "object",
        "properties": {
          "actualDateTime": {
            "type": "string",
            "description": "The actual date and time when the event occurred.",
            "format": "date-time"
          },
          "actualOrEstimateDateTime": {
            "type": "string",
            "description": "Represents the actual date and time if the event has occurred. Otherwise, represents the estimated date and time, if available.",
            "format": "date-time",
            "deprecated": true
          },
          "actualOrEstimateDateTimeInfo": {
            "$ref": "#/components/schemas/TrackedShipmentDateTime"
          },
          "carrierInitialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the carrier expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "carrierInitialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the carrier expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "carrierLatestPlannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the carrier expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "carrierLatestPlannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the carrier expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "customerInitialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the customer expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "customerInitialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the customer expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "customerLatestPlannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the customer expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "customerLatestPlannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the customer expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "deltaEstimated": {
            "type": "integer",
            "description": "The difference in time, in minutes, between the planned time of this event and its estimated time.\n\nA positive value represents later than planned; a negative value represents earlier than planned.\n\nThis field will only be populated if both planned time and estimated time exist. It may be populated even after the event has occurred.",
            "format": "int64"
          },
          "deltaActual": {
            "type": "integer",
            "description": "The difference in time, in minutes, between the planned time of this event and its actual time.\n\nA positive value represents later than planned; a negative value represents earlier than planned.\n\nThis field will only be populated if both planned time and estimated time exist. It may be populated even after the event has occurred.",
            "format": "int64"
          },
          "deltaActualOrEstimated": {
            "type": "integer",
            "description": "Represents the difference in time, in minutes, between the planned time and the actual time if the event has occurred. Otherwise, represents the difference in time, in minutes, between the planned time and the estimated time.",
            "format": "int64"
          },
          "eventType": {
            "type": "string",
            "description": "The type of the event that generated this milestone. This field may be null if there are no eligible events at the target stop.",
            "enum": [
              "UNKNOWN",
              "TRACKING_INITIATE",
              "TRACKING_START",
              "ARRIVAL_AT_STOP",
              "DEPARTURE_FROM_STOP",
              "LOAD_ONTO_VEHICLE",
              "UNLOAD_FROM_VEHICLE",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_END_BY_USER",
              "TRACKING_COMPLETE",
              "GATE_IN",
              "GATE_OUT",
              "FLIGHT_BOOKING",
              "MANIFEST",
              "RECEIVE_FROM_SHIPPER",
              "CONSIGNEE_NOTIFY",
              "DELIVERY",
              "WARNING",
              "EXCEPTION",
              "TRACKING_STOP",
              "EXCEPTION_LATE_DEPARTURE",
              "EXCEPTION_MISSED_CONNECTION",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT_FULL",
              "LOAD",
              "DISCHARGE",
              "EXCEPTION_DELAYED",
              "EXCEPTION_DELIVERY_MISSED",
              "EXCEPTION_HELD",
              "EXCEPTION_PICKUP_MISSED",
              "AVAILABLE",
              "ENTERED_GEOFENCE",
              "EXITED_GEOFENCE",
              "INFO",
              "OUT_FOR_DELIVERY",
              "PICKED_UP",
              "RETURN_TO_SENDER",
              "TRACKING_FAILED",
              "UNAUTHORIZED",
              "PICKUP_MISSED",
              "SURVEY",
              "HELD",
              "RELEASE",
              "DELAYED",
              "DELIVERY_MISSED",
              "ENTERED_INNER_GEOFENCE",
              "EXITED_INNER_GEOFENCE",
              "ENTERED_OUTER_GEOFENCE",
              "EXITED_OUTER_GEOFENCE",
              "ENTERED_FINAL_GEOFENCE",
              "EXITED_FINAL_GEOFENCE",
              "IDLE",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "DISPATCH",
              "CUSTOMS_HOLD",
              "CUSTOMS_CLEARANCE",
              "CUSTOMS_DOCS_FILING",
              "CUSTOMS_TRANSIT_DOCS_ISSUED",
              "CUSTOMS_TRANSIT_DOCS_CLOSED",
              "CARRIER_HOLD",
              "RECEIVE_FROM_CARRIER",
              "ISSUE_FREIGHT_BILL",
              "FREIGHT_ON_HAND",
              "READY_FOR_CARRIAGE",
              "LAST_FREE_DAY",
              "MISSING_CARRIER",
              "STUFF",
              "STRIP",
              "SEAL_INSPECTION",
              "SEAL_REMOVAL",
              "SEAL_RESEAL",
              "HANDOVER",
              "DOCUMENT_ADD",
              "DOCUMENT_REMOVE",
              "REMOVE_FROM_BOOKING",
              "COST_UPDATE",
              "SHARING_STOPPED",
              "ROLLED_OVER",
              "BAD_ORDER",
              "BAD_ORDER_RELEASE"
            ]
          },
          "estimateDateTime": {
            "type": "string",
            "description": "The date and time at which the event is/was expected to occur. This field may be populated even after the event occurs.",
            "format": "date-time",
            "deprecated": true
          },
          "estimateDateTimeInfo": {
            "$ref": "#/components/schemas/TrackedShipmentDateTime"
          },
          "initialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the event occurred. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "initialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the event occurred. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "index": {
            "type": "integer",
            "description": "Some milestones can occur multiple times. For such milestones, this field is used to distinguish the occurrences.",
            "format": "int64"
          },
          "plannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the event occurred. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "plannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the event occurred. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "stop": {
            "$ref": "#/components/schemas/TrackedShipmentStop"
          },
          "type": {
            "type": "string",
            "description": "The type of milestone represented by this object.\n\n`GATE_OUT_EMPTY_AT_FIRST_PORT` ( GATE_OUT_EMPTY event at the first PORT_OF_LOADING stop in the route )\n\n`GATE_IN_FULL_AT_FIRST_PORT` ( GATE_IN_FULL event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_DOCS_FILING_AT_FIRST_PORT` ( CUSTOMS_DOCS_FILING event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_CLEARANCE_AT_FIRST_PORT` ( CUSTOMS_CLEARANCE event at the first PORT_OF_LOADING stop in the route )\n\n`LOAD_AT_FIRST_PORT` ( LOAD event at the first PORT_OF_LOADING stop in the route )\n\n`DEPARTURE_FROM_FIRST_PORT` ( DEPARTURE_FROM_STOP event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_DOCS_FILING_AT_LAST_PORT` ( CUSTOMS_DOCS_FILING event at the first PORT_OF_DISCHARGE stop in the route )\n\n`CUSTOMS_CLEARANCE_AT_LAST_PORT` ( CUSTOMS_CLEARANCE event at the first PORT_OF_DISCHARGE stop in the route )\n\n`GATE_OUT_FULL_AT_LAST_PORT` ( GATE_OUT_FULL event at the last PORT_OF_DISCHARGE stop in the route )\n\n`GATE_IN_EMPTY_AT_LAST_PORT` ( GATE_IN_EMPTY event at the last PORT_OF_DISCHARGE stop in the route )\n\n`ARRIVAL_AT_LAST_PORT` ( ARRIVAL_AT_STOP event at the last PORT_OF_DISCHARGE stop in the route )\n\n`DISCHARGE_AT_LAST_PORT` ( DISCHARGE event at the last PORT_OF_DISCHARGE stop in the route )\n\n`RECEIVE_FROM_CARRIER_AT_LAST_PORT` ( RECEIVE_FROM_CARRIER event at the last PORT_OF_DISCHARGE stop in the route )\n\n`LAST_FREE_DAY_DEMURRAGE_AT_LAST_PORT` ( LAST_FREE_DAY event with event description 'Import Demurrage' at the last PORT_OF_DISCHARGE stop in the route )\n\n`LAST_FREE_DAY_DETENTION_AT_LAST_PORT` ( LAST_FREE_DAY event with event description 'Import Detention' at the last PORT_OF_DISCHARGE stop in the route )\n\n`ARRIVAL_AT_ABSOLUTE_ORIGIN` ( ARRIVAL_AT_STOP event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`PICKED_UP_AT_ABSOLUTE_ORIGIN` ( PICKED_UP event (preferred) or GATE_OUT_FULL event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`DEPARTURE_FROM_ABSOLUTE_ORIGIN` ( DEPARTURE_FROM_STOP event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`ARRIVAL_AT_ABSOLUTE_DESTINATION` ( ARRIVAL_AT_STOP event (preferred) or GATE_IN_FULL event at the last stop in the route that is of type DESTINATION, DELIVERY, or PORT_OF_DISCHARGE )\n\n`DELIVERY_AT_ABSOLUTE_DESTINATION` ( DELIVERY event at the last stop in the route that is of type DESTINATION, DELIVERY, or PORT_OF_DISCHARGE )\n\n `GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL` ( GATE_OUT_EMPTY event at terminal )\n\n`BOOKING_CONFIRMED_BY_FFW` ( BOOKING_CONFIRMED event by Freight Forwarder )\n\n`BOOKING_CONFIRMED_BY_OCEAN_CARRIER` ( BOOKING_CONFIRMED event by Ocean Carrier )\n\n`BOOKING_CANCELLED` ( BOOKING_CANCELLED event )\n\n`ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN` ( STUFF event at ORIGIN stop )\n\n`PICKED_UP_FULL_CONTAINER_AT_ORIGIN` ( PICKED_UP event at ORIGIN stop )\n\n`ARRIVAL_AT_EXPORT_WAREHOUSE` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`DEPARTURE_FROM_EXPORT_WAREHOUSE` ( DEPARTURE_FROM_STOP event at ORIGIN stop )\n\n`ARRIVAL_AT_ORIGIN_CFS` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`LOAD_INTO_CONTAINER_AT_ORIGIN_CFS` ( LOAD event at ORIGIN stop )\n\n`DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS` ( DEPARTURE_FROM_STOP event at ORIGIN stop )\n\n`EXPORT_CUSTOMS_DOCS_FILING` ( CUSTOMS_DOCS_FILING event at PORT_OF_LOADING stop )\n\n`EXPORT_CUSTOMS_HOLD` ( CUSTOMS_HOLD event at PORT_OF_LOADING stop )\n\n`EXPORT_CUSTOMS_CLEARANCE` ( CUSTOMS_CLEARANCE event at PORT_OF_LOADING stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( ARRIVAL_AT_STOP event at TRANSFER stop )\n\n`DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( DISCHARGE event at TRANSFER stop )\n\n`LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( LOAD event at TRANSFER stop )\n\n`DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL` ( DEPARTURE_FROM_STOP event at TRANSFER stop )\n\n`GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING` ( GATE_IN_FULL event at PORT_OF_LOADING stop )\n\n`LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING` ( LOAD event at PORT_OF_LOADING stop )\n\n`VESSEL_DEPARTURE_FROM_PORT_OF_LOADING` ( DEPARTURE_FROM_STOP event at PORT_OF_LOADING stop )\n\n`SHORT_SHIPPED_AT_PORT_OF_LOADING` ( SHORT_SHIPPED event at PORT_OF_LOADING stop )\n\n`VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT` ( ARRIVAL_AT_STOP event at TRANSSHIPMENT_PORT stop )\n\n`DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT` ( DISCHARGE event at TRANSSHIPMENT_PORT stop )\n\n`ARRIVAL_AT_TRANSSHIPMENT_CFS` ( ARRIVAL_AT_STOP event at TRANSSHIPMENT_PORT stop )\n\n`DISCHARGE_AT_TRANSSHIPMENT_CFS` ( DISCHARGE event at TRANSSHIPMENT_PORT stop )\n\n`LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS` ( LOAD event at TRANSSHIPMENT_PORT stop )\n\n`DEPARTURE_FROM_TRANSSHIPMENT_CFS` ( DEPARTURE_FROM_STOP event at TRANSSHIPMENT_PORT stop )\n\n`LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT` ( LOAD event at TRANSSHIPMENT_PORT stop )\n\n`GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT` ( GATE_OUT_FULL event at TRANSSHIPMENT_PORT stop )\n\n`GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT` ( GATE_IN_FULL event at TRANSSHIPMENT_PORT stop )\n\n`VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT` ( DEPARTURE_FROM_STOP event at TRANSSHIPMENT_PORT stop )\n\n`SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT` ( SHORT_SHIPPED event at TRANSSHIPMENT_PORT stop )\n\n`VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE` ( ARRIVAL_AT_STOP event at PORT_OF_DISCHARGE stop )\n\n`DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE` ( DISCHARGE event at PORT_OF_DISCHARGE stop )\n\n`CARRIER_HOLD_AT_PORT_OF_DISCHARGE` ( CARRIER_HOLD event at PORT_OF_DISCHARGE stop )\n\n`CARRIER_RELEASE_AT_PORT_OF_DISCHARGE` ( CARRIER_RELEASE event at PORT_OF_DISCHARGE stop )\n\n`GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE` ( GATE_OUT_FULL event at PORT_OF_DISCHARGE stop )\n\n`DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( DISCHARGE event at TRANSFER stop )\n\n`SHORT_SHIPPED_AT_PORT_OF_DISCHARGE` ( SHORT_SHIPPED event at PORT_OF_DISCHARGE stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( ARRIVAL_AT_STOP event at TRANSFER stop )\n\n`LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( LOAD event at TRANSFER stop )\n\n`DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL` ( DEPARTURE_FROM_STOP event at TRANSFER stop )\n\n`IMPORT_CUSTOMS_DOCS_FILING` ( CUSTOMS_DOCS_FILING event at PORT_OF_DISCHARGE stop )\n\n`IMPORT_CUSTOMS_HOLD` ( CUSTOMS_HOLD event at PORT_OF_DISCHARGE or TRANSFER stop )\n\n`IMPORT_CUSTOMS_CLEARANCE` ( CUSTOMS_CLEARANCE event at PORT_OF_DISCHARGE or TRANSFER stop )\n\n`ARRIVAL_AT_DESTINATION_CFS` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`STRIP_AT_DESTINATION_CFS` ( STRIP event at DESTINATION stop )\n\n`DEPARTURE_FROM_DESTINATION_CFS` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`ARRIVAL_AT_IMPORT_WAREHOUSE` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`DEPARTURE_FROM_IMPORT_WAREHOUSE` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`OUT_FOR_DELIVERY` ( OUT_FOR_DELIVERY event at DESTINATION stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`PROOF_OF_DELIVERY` ( DELIVERY event at DESTINATION stop )\n\n`HANDOVER_TO_THIRD_PARTY` ( DELIVERY event at DESTINATION stop )\n\n`READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION` ( STRIP event at DESTINATION stop )\n\n`PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`GATE_IN_EMPTY_CONTAINER_AT_TERMINAL` ( GATE_IN_EMPTY event at RETURN stop )",
            "enum": [
              "GATE_OUT_EMPTY_AT_FIRST_PORT",
              "GATE_IN_FULL_AT_FIRST_PORT",
              "CUSTOMS_DOCS_FILING_AT_FIRST_PORT",
              "CUSTOMS_CLEARANCE_AT_FIRST_PORT",
              "LOAD_AT_FIRST_PORT",
              "DEPARTURE_FROM_FIRST_PORT",
              "CUSTOMS_DOCS_FILING_AT_LAST_PORT",
              "CUSTOMS_CLEARANCE_AT_LAST_PORT",
              "GATE_OUT_FULL_AT_LAST_PORT",
              "GATE_IN_EMPTY_AT_LAST_PORT",
              "ARRIVAL_AT_LAST_PORT",
              "DISCHARGE_AT_LAST_PORT",
              "RECEIVE_FROM_CARRIER_AT_LAST_PORT",
              "LAST_FREE_DAY_DEMURRAGE_AT_LAST_PORT",
              "LAST_FREE_DAY_DETENTION_AT_LAST_PORT",
              "ARRIVAL_AT_ABSOLUTE_ORIGIN",
              "PICKED_UP_AT_ABSOLUTE_ORIGIN",
              "DEPARTURE_FROM_ABSOLUTE_ORIGIN",
              "ARRIVAL_AT_ABSOLUTE_DESTINATION",
              "DELIVERY_AT_ABSOLUTE_DESTINATION",
              "ARRIVAL_AT_FIRST_TRANSSHIPMENT_PORT",
              "DISCHARGE_AT_FIRST_TRANSSHIPMENT_PORT",
              "LOAD_AT_FIRST_TRANSSHIPMENT_PORT",
              "DEPART_FROM_FIRST_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_ANY_TRANSSHIPMENT_PORT",
              "DISCHARGE_AT_ANY_TRANSSHIPMENT_PORT",
              "LOAD_AT_ANY_TRANSSHIPMENT_PORT",
              "DEPART_FROM_ANY_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_LAST_TRANSFER",
              "AVAILABLE_AT_LAST_TRANSFER",
              "GATE_IN_EMPTY_AT_LAST_TRANSFER",
              "DEPARTURE_FROM_LAST_TRANSFER",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL",
              "BOOKING_CONFIRMED_BY_FFW",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER",
              "BOOKING_CANCELLED",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN",
              "ARRIVAL_AT_EXPORT_WAREHOUSE",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE",
              "ARRIVAL_AT_ORIGIN_CFS",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS",
              "EXPORT_CUSTOMS_DOCS_FILING",
              "EXPORT_CUSTOMS_HOLD",
              "EXPORT_CUSTOMS_CLEARANCE",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL",
              "IMPORT_CUSTOMS_DOCS_FILING",
              "IMPORT_CUSTOMS_HOLD",
              "IMPORT_CUSTOMS_CLEARANCE",
              "ARRIVAL_AT_DESTINATION_CFS",
              "STRIP_AT_DESTINATION_CFS",
              "DEPARTURE_FROM_DESTINATION_CFS",
              "ARRIVAL_AT_IMPORT_WAREHOUSE",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE",
              "OUT_FOR_DELIVERY",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE",
              "PROOF_OF_DELIVERY",
              "HANDOVER_TO_THIRD_PARTY",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL",
              "HELD_CUSTOM_HOLD_CARRIER_HOLD",
              "UNKNOWN"
            ]
          }
        },
        "description": "A pairing of a stop along the shipment's route and an event that has happened or is planned to happen at that stop.\n\nTogether, this pair represents a milestone in the shipment's lifecycle, complete with planned, estimated, and actual datetimes.\n\nExample: The ARRIVAL_AT_ABSOLUTE_DESTINATION milestone represents the stop that is considered to be the shipment's absolute destination as well as the corresponding arrival event for that stop."
      },
      "ShipmentMilestoneSortField": {
        "required": [],
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "enum": [
              "ACTUAL_DATE_TIME",
              "ESTIMATE_DATE_TIME",
              "ACTUAL_OR_ESTIMATE_DATE_TIME",
              "INITIAL_PLANNED_DATE_TIME",
              "INITIAL_PLANNED_END_DATE_TIME",
              "LATEST_PLANNED_DATE_TIME",
              "LATEST_PLANNED_END_DATE_TIME",
              "CARRIER_INITIAL_PLANNED_DATE_TIME",
              "CARRIER_INITIAL_PLANNED_END_DATE_TIME",
              "CARRIER_LATEST_PLANNED_DATE_TIME",
              "CARRIER_LATEST_PLANNED_END_DATE_TIME",
              "CUSTOMER_INITIAL_PLANNED_DATE_TIME",
              "CUSTOMER_INITIAL_PLANNED_END_DATE_TIME",
              "CUSTOMER_LATEST_PLANNED_DATE_TIME",
              "CUSTOMER_LATEST_PLANNED_END_DATE_TIME",
              "PLANNED_TO_ACTUAL_DELTA",
              "PLANNED_TO_ESTIMATE_DELTA",
              "PLANNED_TO_ACTUAL_OR_ESTIMATE_DELTA"
            ]
          },
          "milestoneType": {
            "type": "string",
            "description": "The type of milestone represented by this object.\n\n`GATE_OUT_EMPTY_AT_FIRST_PORT` ( GATE_OUT_EMPTY event at the first PORT_OF_LOADING stop in the route )\n\n`GATE_IN_FULL_AT_FIRST_PORT` ( GATE_IN_FULL event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_DOCS_FILING_AT_FIRST_PORT` ( CUSTOMS_DOCS_FILING event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_CLEARANCE_AT_FIRST_PORT` ( CUSTOMS_CLEARANCE event at the first PORT_OF_LOADING stop in the route )\n\n`LOAD_AT_FIRST_PORT` ( LOAD event at the first PORT_OF_LOADING stop in the route )\n\n`DEPARTURE_FROM_FIRST_PORT` ( DEPARTURE_FROM_STOP event at the first PORT_OF_LOADING stop in the route )\n\n`CUSTOMS_DOCS_FILING_AT_LAST_PORT` ( CUSTOMS_DOCS_FILING event at the first PORT_OF_DISCHARGE stop in the route )\n\n`CUSTOMS_CLEARANCE_AT_LAST_PORT` ( CUSTOMS_CLEARANCE event at the first PORT_OF_DISCHARGE stop in the route )\n\n`GATE_OUT_FULL_AT_LAST_PORT` ( GATE_OUT_FULL event at the last PORT_OF_DISCHARGE stop in the route )\n\n`GATE_IN_EMPTY_AT_LAST_PORT` ( GATE_IN_EMPTY event at the last PORT_OF_DISCHARGE stop in the route )\n\n`ARRIVAL_AT_LAST_PORT` ( ARRIVAL_AT_STOP event at the last PORT_OF_DISCHARGE stop in the route )\n\n`DISCHARGE_AT_LAST_PORT` ( DISCHARGE event at the last PORT_OF_DISCHARGE stop in the route )\n\n`RECEIVE_FROM_CARRIER_AT_LAST_PORT` ( RECEIVE_FROM_CARRIER event at the last PORT_OF_DISCHARGE stop in the route )\n\n`LAST_FREE_DAY_DEMURRAGE_AT_LAST_PORT` ( LAST_FREE_DAY event with event description 'Import Demurrage' at the last PORT_OF_DISCHARGE stop in the route )\n\n`LAST_FREE_DAY_DETENTION_AT_LAST_PORT` ( LAST_FREE_DAY event with event description 'Import Detention' at the last PORT_OF_DISCHARGE stop in the route )\n\n`ARRIVAL_AT_ABSOLUTE_ORIGIN` ( ARRIVAL_AT_STOP event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`PICKED_UP_AT_ABSOLUTE_ORIGIN` ( PICKED_UP event (preferred) or GATE_OUT_FULL event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`DEPARTURE_FROM_ABSOLUTE_ORIGIN` ( DEPARTURE_FROM_STOP event at the first stop in the route that is of type ORIGIN, PICKUP, or PORT_OF_LOADING )\n\n`ARRIVAL_AT_ABSOLUTE_DESTINATION` ( ARRIVAL_AT_STOP event (preferred) or GATE_IN_FULL event at the last stop in the route that is of type DESTINATION, DELIVERY, or PORT_OF_DISCHARGE )\n\n`DELIVERY_AT_ABSOLUTE_DESTINATION` ( DELIVERY event at the last stop in the route that is of type DESTINATION, DELIVERY, or PORT_OF_DISCHARGE )\n\n `GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL` ( GATE_OUT_EMPTY event at terminal )\n\n`BOOKING_CONFIRMED_BY_FFW` ( BOOKING_CONFIRMED event by Freight Forwarder )\n\n`BOOKING_CONFIRMED_BY_OCEAN_CARRIER` ( BOOKING_CONFIRMED event by Ocean Carrier )\n\n`BOOKING_CANCELLED` ( BOOKING_CANCELLED event )\n\n`ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN` ( STUFF event at ORIGIN stop )\n\n`PICKED_UP_FULL_CONTAINER_AT_ORIGIN` ( PICKED_UP event at ORIGIN stop )\n\n`ARRIVAL_AT_EXPORT_WAREHOUSE` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`DEPARTURE_FROM_EXPORT_WAREHOUSE` ( DEPARTURE_FROM_STOP event at ORIGIN stop )\n\n`ARRIVAL_AT_ORIGIN_CFS` ( ARRIVAL_AT_STOP event at ORIGIN stop )\n\n`LOAD_INTO_CONTAINER_AT_ORIGIN_CFS` ( LOAD event at ORIGIN stop )\n\n`DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS` ( DEPARTURE_FROM_STOP event at ORIGIN stop )\n\n`EXPORT_CUSTOMS_DOCS_FILING` ( CUSTOMS_DOCS_FILING event at PORT_OF_LOADING stop )\n\n`EXPORT_CUSTOMS_HOLD` ( CUSTOMS_HOLD event at PORT_OF_LOADING stop )\n\n`EXPORT_CUSTOMS_CLEARANCE` ( CUSTOMS_CLEARANCE event at PORT_OF_LOADING stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( ARRIVAL_AT_STOP event at TRANSFER stop )\n\n`DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( DISCHARGE event at TRANSFER stop )\n\n`LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL` ( LOAD event at TRANSFER stop )\n\n`DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL` ( DEPARTURE_FROM_STOP event at TRANSFER stop )\n\n`GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING` ( GATE_IN_FULL event at PORT_OF_LOADING stop )\n\n`LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING` ( LOAD event at PORT_OF_LOADING stop )\n\n`VESSEL_DEPARTURE_FROM_PORT_OF_LOADING` ( DEPARTURE_FROM_STOP event at PORT_OF_LOADING stop )\n\n`SHORT_SHIPPED_AT_PORT_OF_LOADING` ( SHORT_SHIPPED event at PORT_OF_LOADING stop )\n\n`VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT` ( ARRIVAL_AT_STOP event at TRANSSHIPMENT_PORT stop )\n\n`DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT` ( DISCHARGE event at TRANSSHIPMENT_PORT stop )\n\n`ARRIVAL_AT_TRANSSHIPMENT_CFS` ( ARRIVAL_AT_STOP event at TRANSSHIPMENT_PORT stop )\n\n`DISCHARGE_AT_TRANSSHIPMENT_CFS` ( DISCHARGE event at TRANSSHIPMENT_PORT stop )\n\n`LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS` ( LOAD event at TRANSSHIPMENT_PORT stop )\n\n`DEPARTURE_FROM_TRANSSHIPMENT_CFS` ( DEPARTURE_FROM_STOP event at TRANSSHIPMENT_PORT stop )\n\n`LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT` ( LOAD event at TRANSSHIPMENT_PORT stop )\n\n`GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT` ( GATE_OUT_FULL event at TRANSSHIPMENT_PORT stop )\n\n`GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT` ( GATE_IN_FULL event at TRANSSHIPMENT_PORT stop )\n\n`VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT` ( DEPARTURE_FROM_STOP event at TRANSSHIPMENT_PORT stop )\n\n`SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT` ( SHORT_SHIPPED event at TRANSSHIPMENT_PORT stop )\n\n`VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE` ( ARRIVAL_AT_STOP event at PORT_OF_DISCHARGE stop )\n\n`DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE` ( DISCHARGE event at PORT_OF_DISCHARGE stop )\n\n`CARRIER_HOLD_AT_PORT_OF_DISCHARGE` ( CARRIER_HOLD event at PORT_OF_DISCHARGE stop )\n\n`CARRIER_RELEASE_AT_PORT_OF_DISCHARGE` ( CARRIER_RELEASE event at PORT_OF_DISCHARGE stop )\n\n`GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE` ( GATE_OUT_FULL event at PORT_OF_DISCHARGE stop )\n\n`DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( DISCHARGE event at TRANSFER stop )\n\n`SHORT_SHIPPED_AT_PORT_OF_DISCHARGE` ( SHORT_SHIPPED event at PORT_OF_DISCHARGE stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( ARRIVAL_AT_STOP event at TRANSFER stop )\n\n`LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL` ( LOAD event at TRANSFER stop )\n\n`DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL` ( DEPARTURE_FROM_STOP event at TRANSFER stop )\n\n`IMPORT_CUSTOMS_DOCS_FILING` ( CUSTOMS_DOCS_FILING event at PORT_OF_DISCHARGE stop )\n\n`IMPORT_CUSTOMS_HOLD` ( CUSTOMS_HOLD event at PORT_OF_DISCHARGE or TRANSFER stop )\n\n`IMPORT_CUSTOMS_CLEARANCE` ( CUSTOMS_CLEARANCE event at PORT_OF_DISCHARGE or TRANSFER stop )\n\n`ARRIVAL_AT_DESTINATION_CFS` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`STRIP_AT_DESTINATION_CFS` ( STRIP event at DESTINATION stop )\n\n`DEPARTURE_FROM_DESTINATION_CFS` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`ARRIVAL_AT_IMPORT_WAREHOUSE` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`DEPARTURE_FROM_IMPORT_WAREHOUSE` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`OUT_FOR_DELIVERY` ( OUT_FOR_DELIVERY event at DESTINATION stop )\n\n`ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE` ( ARRIVAL_AT_STOP event at DESTINATION stop )\n\n`PROOF_OF_DELIVERY` ( DELIVERY event at DESTINATION stop )\n\n`HANDOVER_TO_THIRD_PARTY` ( DELIVERY event at DESTINATION stop )\n\n`READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION` ( STRIP event at DESTINATION stop )\n\n`PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE` ( DEPARTURE_FROM_STOP event at DESTINATION stop )\n\n`GATE_IN_EMPTY_CONTAINER_AT_TERMINAL` ( GATE_IN_EMPTY event at RETURN stop )",
            "enum": [
              "GATE_OUT_EMPTY_AT_FIRST_PORT",
              "GATE_IN_FULL_AT_FIRST_PORT",
              "CUSTOMS_DOCS_FILING_AT_FIRST_PORT",
              "CUSTOMS_CLEARANCE_AT_FIRST_PORT",
              "LOAD_AT_FIRST_PORT",
              "DEPARTURE_FROM_FIRST_PORT",
              "CUSTOMS_DOCS_FILING_AT_LAST_PORT",
              "CUSTOMS_CLEARANCE_AT_LAST_PORT",
              "GATE_OUT_FULL_AT_LAST_PORT",
              "GATE_IN_EMPTY_AT_LAST_PORT",
              "ARRIVAL_AT_LAST_PORT",
              "DISCHARGE_AT_LAST_PORT",
              "RECEIVE_FROM_CARRIER_AT_LAST_PORT",
              "LAST_FREE_DAY_DEMURRAGE_AT_LAST_PORT",
              "LAST_FREE_DAY_DETENTION_AT_LAST_PORT",
              "ARRIVAL_AT_ABSOLUTE_ORIGIN",
              "PICKED_UP_AT_ABSOLUTE_ORIGIN",
              "DEPARTURE_FROM_ABSOLUTE_ORIGIN",
              "ARRIVAL_AT_ABSOLUTE_DESTINATION",
              "DELIVERY_AT_ABSOLUTE_DESTINATION",
              "ARRIVAL_AT_FIRST_TRANSSHIPMENT_PORT",
              "DISCHARGE_AT_FIRST_TRANSSHIPMENT_PORT",
              "LOAD_AT_FIRST_TRANSSHIPMENT_PORT",
              "DEPART_FROM_FIRST_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_ANY_TRANSSHIPMENT_PORT",
              "DISCHARGE_AT_ANY_TRANSSHIPMENT_PORT",
              "LOAD_AT_ANY_TRANSSHIPMENT_PORT",
              "DEPART_FROM_ANY_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_LAST_TRANSFER",
              "AVAILABLE_AT_LAST_TRANSFER",
              "GATE_IN_EMPTY_AT_LAST_TRANSFER",
              "DEPARTURE_FROM_LAST_TRANSFER",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL",
              "BOOKING_CONFIRMED_BY_FFW",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER",
              "BOOKING_CANCELLED",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN",
              "ARRIVAL_AT_EXPORT_WAREHOUSE",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE",
              "ARRIVAL_AT_ORIGIN_CFS",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS",
              "EXPORT_CUSTOMS_DOCS_FILING",
              "EXPORT_CUSTOMS_HOLD",
              "EXPORT_CUSTOMS_CLEARANCE",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL",
              "IMPORT_CUSTOMS_DOCS_FILING",
              "IMPORT_CUSTOMS_HOLD",
              "IMPORT_CUSTOMS_CLEARANCE",
              "ARRIVAL_AT_DESTINATION_CFS",
              "STRIP_AT_DESTINATION_CFS",
              "DEPARTURE_FROM_DESTINATION_CFS",
              "ARRIVAL_AT_IMPORT_WAREHOUSE",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE",
              "OUT_FOR_DELIVERY",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE",
              "PROOF_OF_DELIVERY",
              "HANDOVER_TO_THIRD_PARTY",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL",
              "HELD_CUSTOM_HOLD_CARRIER_HOLD",
              "UNKNOWN"
            ]
          }
        },
        "description": "Defines a sortable field that is found within the milestones collection."
      },
      "ShipmentModeFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "CURRENT"
              ]
            }
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "AIR",
                "OCEAN",
                "RAIL",
                "UNKNOWN",
                "TRUCKLOAD",
                "PARCEL",
                "LTL",
                "BARGE"
              ]
            }
          }
        },
        "description": "Match shipments based on the mode of transportation. By default, the criterion is checked against past, current, and planned modes of transportation. To limit the scope of this check, use the scopes field. Omit the scopes field to search all scopes.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (segments.transportationMode EQUALS [A OR B OR C])\n\nExample: (segments.transportationMode NOT_EQUALS A) AND (segments.transportationMode NOT_EQUALS B)"
      },
      "ShipmentNoteConfiguration": {
        "description": "Configuration of the pickup note that will be constructed by project44. Pickup note construction is used to send some requested accessorial services to capacity providers through their API when no other API field is available for these services. It is also used to send the delivery note through the capacity provider's pickup note API field. If no note configuration is provided, the default note configuration will be used, which will send the following note sections in order and will not enable truncation: pickup note, priority accessorials, pickup accessorials, dimensions, delivery note, delivery accessorials, and other accessorials.",
        "properties": {
          "enableTruncation": {
            "description": "If set to 'true', project44 will truncate the final pickup note it constructs if it exceeds the maximum allowable length for the capacity provider. When 'false', an error will be returned and the shipment will be not placed for pickup with the capacity provider if the constructed pickup note exceeds the maximum allowable length for the capacity provider. (default: 'false')",
            "type": "boolean"
          },
          "noteSections": {
            "description": "A list of sections, in order, to send through the capacity provider's pickup note API field. Brief descriptions of accessorial services will be used. Item dimensions are added in the format 00x00x00. If not provided, the default note sections, in order, are as follows: pickup note, priority accessorials, pickup accessorials, dimensions, delivery note, delivery accessorials, and other accessorials.",
            "items": {
              "$ref": "#/components/schemas/ShipmentNoteSection"
            },
            "type": "array"
          }
        },
        "title": "ShipmentNoteConfiguration",
        "type": "object"
      },
      "ShipmentNoteSection": {
        "description": "A section of the shipment note to be sent to the capacity provider.",
        "properties": {
          "name": {
            "description": "Name identifying this note section.",
            "enum": [
              "PICKUP_NOTE",
              "PRIORITY_ACCESSORIALS",
              "PICKUP_ACCESSORIALS",
              "DELIVERY_ACCESSORIALS",
              "OTHER_ACCESSORIALS",
              "DELIVERY_NOTE",
              "DIMENSIONS"
            ],
            "type": "string"
          }
        },
        "title": "ShipmentNoteSection",
        "type": "object"
      },
      "ShipmentOrder": {
        "type": "object",
        "properties": {
          "additionalIdentifiers": {
            "type": "array",
            "description": "Additional terms to describe the order.",
            "items": {
              "$ref": "#/components/schemas/AdditionalOrderIdentifier"
            }
          },
          "deliveryEstimateStatus": {
            "$ref": "#/components/schemas/OrderArrivalStatus"
          },
          "deliveryEstimateDateTime": {
            "type": "string",
            "description": "The date and time when the order is predicted to be delivered. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500)",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "Internal identifier to uniquely identify the order."
          },
          "identifier": {
            "$ref": "#/components/schemas/OrderIdentifier"
          },
          "launchDateTime": {
            "type": "string",
            "description": "Date and time when a launch of the order is planned. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500)",
            "format": "date-time"
          },
          "originalDeliveryDateTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "supplier": {
            "$ref": "#/components/schemas/OrderSupplier"
          },
          "supplierReadyDateTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "tags": {
            "type": "array",
            "description": "Non-unique terms to describe how orders are managed within the organization. Used when searching and filtering by a specific department, team, category.",
            "items": {
              "$ref": "#/components/schemas/OrderTag"
            }
          }
        },
        "description": "An order that is related to a shipment."
      },
      "ShipmentPlan": {
        "type": "object",
        "properties": {
          "expectedTransportationModes": {
            "type": "array",
            "description": "${ShipmentPlan.apiModel.expectedTransportationModes.value}",
            "xml": {
              "wrapped": true
            },
            "items": {
              "type": "string",
              "description": "${ShipmentPlan.apiModel.expectedTransportationModes.value}",
              "xml": {
                "name": "expectedTransportationModes"
              },
              "enum": [
                "AIR",
                "OCEAN",
                "RAIL",
                "UNKNOWN",
                "TRUCKLOAD",
                "PARCEL",
                "LTL",
                "BARGE"
              ]
            }
          },
          "exclusions": {
            "type": "array",
            "description": "${ShipmentPlan.apiModel.exclusions.value}",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/Exclusion"
            }
          },
          "vesselTracking": {
            "$ref": "#/components/schemas/VesselTrackingConfig"
          }
        },
        "description": "${ShipmentPlan.apiModel.class.value}"
      },
      "ShipmentPositionHistory": {
        "type": "object",
        "properties": {
          "positions": {
            "type": "array",
            "description": "Locations where this shipment has been recorded. Data may be down-sampled. Will always be in ascending order by the date that the shipment was at that position.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentPosition"
            }
          },
          "shipment": {
            "$ref": "#/components/schemas/TrackedShipment"
          }
        },
        "description": "The history of where this shipment or parts of this shipment were located during tracking."
      },
      "ShipmentRouteInfo": {
        "type": "object",
        "properties": {
          "routeSegments": {
            "type": "array",
            "description": "Contain information about how the shipment moved from each stop to the next. There will always be 1 fewer route segment than number of stops.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentRouteSegment"
            }
          },
          "stops": {
            "type": "array",
            "description": "All stops associated with this shipment. There may be 0 stops while we are still acquiring data for this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentStop"
            }
          }
        },
        "description": "Route info model that contains the stops and route for the shipment."
      },
      "ShipmentSearchCriteria": {
        "type": "object",
        "properties": {
          "loadItemIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedLoadItemIdentifierFilter"
            }
          },
          "loadItemDescriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedLoadItemDescriptionFilter"
            }
          },
          "orderIdentifierTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderIdentifierTypeFilter"
            }
          },
          "orderIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderIdentifierFilter"
            }
          },
          "orderIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderInternalIdFilter"
            }
          },
          "orderSupplierIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderSupplierIdFilter"
            }
          },
          "orderDateRanges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderDateFilter"
            }
          },
          "orderDeltas": {
            "type": "array",
            "description": "Match shipments on the differences between timestamps of related orders. Criteria are ANDed together.",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderDeltaFilter"
            }
          },
          "orderTags": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderTagFilter"
            }
          },
          "orderAdditionalIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderAdditionalIdentifierFilter"
            }
          },
          "searchText": {
            "type": "string",
            "description": "A text-based search against a select set of fields in each shipment. If any of a shipment's select fields contain this value, then that shipment will be included in the result set."
          },
          "shipmentIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentInternalIdFilter"
            }
          },
          "shipmentIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentIdentifierFilter"
            }
          },
          "shipmentAttributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentAttributeFilter"
            }
          },
          "shipmentDates": {
            "type": "array",
            "description": "Match shipments which contain one or more dates that meet all criteria. Criteria are ANDed together, types are ORed together.",
            "items": {
              "$ref": "#/components/schemas/ShipmentDateFilter"
            }
          },
          "shipmentStates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentStateFilter"
            }
          },
          "shipmentEvents": {
            "type": "array",
            "description": "Each item in this array should represent criteria for a distinct event type.",
            "items": {
              "$ref": "#/components/schemas/ShipmentEventFilter"
            }
          },
          "shipmentTrackingStatusEvents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentTrackingStatusEventFilter"
            }
          },
          "shipmentStops": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentStopFilter"
            }
          },
          "shipmentDurations": {
            "type": "array",
            "description": "Match shipments which contain one or more durations that meet all criteria. Criteria are ANDed together, types are ORed together.\n\nExample: (estimated transit time >= 30 minutes AND < 1 day) AND (actual transit time does not exist)\n\nExample: (duration X OR duration Y >= 30 minutes) AND (duration Z < 3 hours)",
            "items": {
              "$ref": "#/components/schemas/ShipmentDurationFilter"
            }
          },
          "sharingContextTenants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentSharingTenantFilter"
            }
          },
          "transportationModes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentModeFilter"
            }
          }
        },
        "description": "A collection of criteria used to filter the result set of shipments.\n\nThe query clauses that are generated by each field in this request are combined together using AND.\n\nExample: ([clauses from shipmentStates]) AND ([clauses from transportationModes])"
      },
      "ShipmentSearchRequest": {
        "type": "object",
        "properties": {
          "additionalFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentAdditionalField"
            }
          },
          "loadItemIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedLoadItemIdentifierFilter"
            }
          },
          "loadItemDescriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedLoadItemDescriptionFilter"
            }
          },
          "orderIdentifierTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderIdentifierTypeFilter"
            }
          },
          "orderIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderIdentifierFilter"
            }
          },
          "orderIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderInternalIdFilter"
            }
          },
          "orderSupplierIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderSupplierIdFilter"
            }
          },
          "orderDateRanges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderDateFilter"
            }
          },
          "orderDeltas": {
            "type": "array",
            "description": "Match shipments on the differences between timestamps of related orders. Criteria are ANDed together.",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderDeltaFilter"
            }
          },
          "orderTags": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderTagFilter"
            }
          },
          "orderAdditionalIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedOrderAdditionalIdentifierFilter"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/PaginationParameters"
          },
          "searchText": {
            "type": "string",
            "description": "A text-based search against a select set of fields in each shipment. If any of a shipment's select fields contain this value, then that shipment will be included in the result set."
          },
          "shipmentIds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentInternalIdFilter"
            }
          },
          "shipmentIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentIdentifierFilter"
            }
          },
          "shipmentAttributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentAttributeFilter"
            }
          },
          "shipmentDates": {
            "type": "array",
            "description": "Match shipments which contain one or more dates that meet all criteria. Criteria are ANDed together, types are ORed together.",
            "items": {
              "$ref": "#/components/schemas/ShipmentDateFilter"
            }
          },
          "shipmentStates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentStateFilter"
            }
          },
          "shipmentEvents": {
            "type": "array",
            "description": "Each item in this array should represent criteria for a distinct event type.",
            "items": {
              "$ref": "#/components/schemas/ShipmentEventFilter"
            }
          },
          "shipmentTrackingStatusEvents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentTrackingStatusEventFilter"
            }
          },
          "shipmentStops": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentStopFilter"
            }
          },
          "shipmentDurations": {
            "type": "array",
            "description": "Match shipments which contain one or more durations that meet all criteria. Criteria are ANDed together, types are ORed together.\n\nExample: (estimated transit time >= 30 minutes AND < 1 day) AND (actual transit time does not exist)\n\nExample: (duration X OR duration Y >= 30 minutes) AND (duration Z < 3 hours)",
            "items": {
              "$ref": "#/components/schemas/ShipmentDurationFilter"
            }
          },
          "sharingContextTenants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentSharingTenantFilter"
            }
          },
          "sort": {
            "type": "array",
            "description": "The set of fields on which to sort. Order is important; sorting is performed hierarchically and the field at the front of this list has the highest precedence. For each field, exactly one of [fieldName, milestoneField] must be provided.",
            "items": {
              "$ref": "#/components/schemas/ShipmentSortField"
            }
          },
          "transportationModes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentModeFilter"
            }
          }
        },
        "description": "A collection of criteria used to filter the result set of shipments.\n\nThe query clauses that are generated by each field in this request are combined together using AND.\n\nExample: ([clauses from shipmentStates]) AND ([clauses from transportationModes])"
      },
      "ShipmentSharingTenantFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "names": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "operator": {
            "type": "string",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "Specifies whether this criterion should match against recipient tenants, originating tenants, or either.\n\nIf not provided, either tenant type can result in a match.",
              "enum": [
                "RECIPIENT",
                "ORIGINATOR"
              ]
            }
          }
        },
        "description": "Match shipments based on the which tenant(s) they have been shared by or shared with.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (tenant.name EQUALS [A OR B OR C])\n\nExample: (tenant.name CONTAINS 'at') AND (tenant.name NOT_EQUALS 'Cat')"
      },
      "ShipmentSortField": {
        "required": [],
        "type": "object",
        "properties": {
          "direction": {
            "$ref": "#/components/schemas/SortDirection"
          },
          "fieldName": {
            "type": "string",
            "enum": [
              "PRIMARY_IDENTIFIER",
              "CARRIER_IDENTIFIER",
              "CREATED_DATETIME",
              "UPDATED_DATETIME",
              "ACTUAL_OR_ESTIMATED_TRANSIT_TIME",
              "ACT_DELIVERY_DATETIME",
              "EST_DELIVERY_DATETIME",
              "ACT_OR_EST_DELIVERY_DATETIME",
              "ACT_DELIVERY_DELTA",
              "EST_DELIVERY_DELTA",
              "ACT_OR_EST_DELIVERY_DELTA",
              "PLANNED_DELIVERY_DATETIME",
              "DEPART_ABS_ORIGIN_ACT_DATETIME",
              "DEPART_ABS_ORIGIN_EST_DATETIME",
              "DEPART_ABS_ORIGIN_ACT_OR_EST_DATETIME",
              "DEPART_ABS_ORIGIN_PLANNED_DATETIME",
              "DEPART_ABS_ORIGIN_PLANNED_END_DATETIME",
              "DEPART_ABS_ORIGIN_INIT_PLANNED_DATETIME",
              "DEPART_ABS_ORIGIN_INIT_PLANNED_END_DATETIME",
              "DEPART_ABS_ORIGIN_ACT_DELTA",
              "DEPART_ABS_ORIGIN_EST_DELTA",
              "DEPART_ABS_ORIGIN_ACT_OR_EST_DELTA",
              "ARRIVE_ABS_DEST_ACT_DATETIME",
              "ARRIVE_ABS_DEST_EST_DATETIME",
              "ARRIVE_ABS_DEST_ACT_OR_EST_DATETIME",
              "ARRIVE_ABS_DEST_PLANNED_DATETIME",
              "ARRIVE_ABS_DEST_PLANNED_END_DATETIME",
              "ARRIVE_ABS_DEST_INIT_PLANNED_DATETIME",
              "ARRIVE_ABS_DEST_INIT_PLANNED_END_DATETIME",
              "ARRIVE_ABS_DEST_ACT_DELTA",
              "ARRIVE_ABS_DEST_EST_DELTA",
              "ARRIVE_ABS_DEST_ACT_OR_EST_DELTA",
              "DEPART_FIRST_POL_ACT_DATETIME",
              "DEPART_FIRST_POL_EST_DATETIME",
              "DEPART_FIRST_POL_ACT_OR_EST_DATETIME",
              "DEPART_FIRST_POL_PLANNED_DATETIME",
              "DEPART_FIRST_POL_PLANNED_END_DATETIME",
              "DEPART_FIRST_POL_INIT_PLANNED_DATETIME",
              "DEPART_FIRST_POL_INIT_PLANNED_END_DATETIME",
              "DEPART_FIRST_POL_ACT_DELTA",
              "DEPART_FIRST_POL_EST_DELTA",
              "DEPART_FIRST_POL_ACT_OR_EST_DELTA",
              "DISCHARGE_LAST_POD_ACT_DATETIME",
              "DISCHARGE_LAST_POD_EST_DATETIME",
              "DISCHARGE_LAST_POD_ACT_OR_EST_DATETIME",
              "DISCHARGE_LAST_POD_PLANNED_DATETIME",
              "DISCHARGE_LAST_POD_PLANNED_END_DATETIME",
              "DISCHARGE_LAST_POD_INIT_PLANNED_DATETIME",
              "DISCHARGE_LAST_POD_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_LAST_POD_ACT_DELTA",
              "DISCHARGE_LAST_POD_EST_DELTA",
              "DISCHARGE_LAST_POD_ACT_OR_EST_DELTA",
              "RECEIVE_LAST_POD_ACT_DATETIME",
              "RECEIVE_LAST_POD_EST_DATETIME",
              "RECEIVE_LAST_POD_ACT_OR_EST_DATETIME",
              "RECEIVE_LAST_POD_PLANNED_DATETIME",
              "RECEIVE_LAST_POD_PLANNED_END_DATETIME",
              "RECEIVE_LAST_POD_INIT_PLANNED_DATETIME",
              "RECEIVE_LAST_POD_INIT_PLANNED_END_DATETIME",
              "RECEIVE_LAST_POD_ACT_DELTA",
              "RECEIVE_LAST_POD_EST_DELTA",
              "RECEIVE_LAST_POD_ACT_OR_EST_DELTA",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_ACT_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_EST_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_ACT_OR_EST_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_PLANNED_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_PLANNED_END_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_INIT_PLANNED_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_INIT_PLANNED_END_DATETIME",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_ACT_DELTA",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_EST_DELTA",
              "LAST_FREE_DAY_DEMURRAGE_LAST_POD_ACT_OR_EST_DELTA",
              "LAST_FREE_DAY_DETENTION_LAST_POD_ACT_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_EST_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_ACT_OR_EST_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_PLANNED_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_PLANNED_END_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_INIT_PLANNED_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_INIT_PLANNED_END_DATETIME",
              "LAST_FREE_DAY_DETENTION_LAST_POD_ACT_DELTA",
              "LAST_FREE_DAY_DETENTION_LAST_POD_EST_DELTA",
              "LAST_FREE_DAY_DETENTION_LAST_POD_ACT_OR_EST_DELTA",
              "DELIVERY_ABS_DEST_ACT_DATETIME",
              "DELIVERY_ABS_DEST_EST_DATETIME",
              "DELIVERY_ABS_DEST_ACT_OR_EST_DATETIME",
              "DELIVERY_ABS_DEST_PLANNED_DATETIME",
              "DELIVERY_ABS_DEST_PLANNED_END_DATETIME",
              "DELIVERY_ABS_DEST_INIT_PLANNED_DATETIME",
              "DELIVERY_ABS_DEST_INIT_PLANNED_END_DATETIME",
              "DELIVERY_ABS_DEST_ACT_DELTA",
              "DELIVERY_ABS_DEST_EST_DELTA",
              "DELIVERY_ABS_DEST_ACT_OR_EST_DELTA",
              "GATE_OUT_EMPTY_POL_ACT_DATETIME",
              "GATE_OUT_EMPTY_POL_EST_DATETIME",
              "GATE_OUT_EMPTY_POL_ACT_OR_EST_DATETIME",
              "GATE_OUT_EMPTY_POL_PLANNED_DATETIME",
              "GATE_OUT_EMPTY_POL_PLANNED_END_DATETIME",
              "GATE_OUT_EMPTY_POL_INIT_PLANNED_DATETIME",
              "GATE_OUT_EMPTY_POL_INIT_PLANNED_END_DATETIME",
              "GATE_OUT_EMPTY_POL_ACT_DELTA",
              "GATE_OUT_EMPTY_POL_EST_DELTA",
              "GATE_OUT_EMPTY_POL_ACT_OR_EST_DELTA",
              "GATE_IN_FULL_POL_ACT_DATETIME",
              "GATE_IN_FULL_POL_EST_DATETIME",
              "GATE_IN_FULL_POL_ACT_OR_EST_DATETIME",
              "GATE_IN_FULL_POL_PLANNED_DATETIME",
              "GATE_IN_FULL_POL_PLANNED_END_DATETIME",
              "GATE_IN_FULL_POL_INIT_PLANNED_DATETIME",
              "GATE_IN_FULL_POL_INIT_PLANNED_END_DATETIME",
              "GATE_IN_FULL_POL_ACT_DELTA",
              "GATE_IN_FULL_POL_EST_DELTA",
              "GATE_IN_FULL_POL_ACT_OR_EST_DELTA",
              "CUSTOMS_DOCS_FILING_POL_ACT_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_EST_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_ACT_OR_EST_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_PLANNED_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_PLANNED_END_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_INIT_PLANNED_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_INIT_PLANNED_END_DATETIME",
              "CUSTOMS_DOCS_FILING_POL_ACT_DELTA",
              "CUSTOMS_DOCS_FILING_POL_EST_DELTA",
              "CUSTOMS_DOCS_FILING_POL_ACT_OR_EST_DELTA",
              "CUSTOMS_CLEARANCE_POL_ACT_DATETIME",
              "CUSTOMS_CLEARANCE_POL_EST_DATETIME",
              "CUSTOMS_CLEARANCE_POL_ACT_OR_EST_DATETIME",
              "CUSTOMS_CLEARANCE_POL_PLANNED_DATETIME",
              "CUSTOMS_CLEARANCE_POL_PLANNED_END_DATETIME",
              "CUSTOMS_CLEARANCE_POL_INIT_PLANNED_DATETIME",
              "CUSTOMS_CLEARANCE_POL_INIT_PLANNED_END_DATETIME",
              "CUSTOMS_CLEARANCE_POL_ACT_DELTA",
              "CUSTOMS_CLEARANCE_POL_EST_DELTA",
              "CUSTOMS_CLEARANCE_POL_ACT_OR_EST_DELTA",
              "LOAD_POL_ACT_DATETIME",
              "LOAD_POL_EST_DATETIME",
              "LOAD_POL_ACT_OR_EST_DATETIME",
              "LOAD_POL_PLANNED_DATETIME",
              "LOAD_POL_PLANNED_END_DATETIME",
              "LOAD_POL_INIT_PLANNED_DATETIME",
              "LOAD_POL_INIT_PLANNED_END_DATETIME",
              "LOAD_POL_ACT_DELTA",
              "LOAD_POL_EST_DELTA",
              "LOAD_POL_ACT_OR_EST_DELTA",
              "ARRIVE_TSP_ACT_DATETIME",
              "ARRIVE_TSP_EST_DATETIME",
              "ARRIVE_TSP_ACT_OR_EST_DATETIME",
              "ARRIVE_TSP_PLANNED_DATETIME",
              "ARRIVE_TSP_PLANNED_END_DATETIME",
              "ARRIVE_TSP_INIT_PLANNED_DATETIME",
              "ARRIVE_TSP_INIT_PLANNED_END_DATETIME",
              "ARRIVE_TSP_ACT_DELTA",
              "ARRIVE_TSP_EST_DELTA",
              "ARRIVE_TSP_ACT_OR_EST_DELTA",
              "DISCHARGE_TSP_ACT_DATETIME",
              "DISCHARGE_TSP_EST_DATETIME",
              "DISCHARGE_TSP_ACT_OR_EST_DATETIME",
              "DISCHARGE_TSP_PLANNED_DATETIME",
              "DISCHARGE_TSP_PLANNED_END_DATETIME",
              "DISCHARGE_TSP_INIT_PLANNED_DATETIME",
              "DISCHARGE_TSP_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_TSP_ACT_DELTA",
              "DISCHARGE_TSP_EST_DELTA",
              "DISCHARGE_TSP_ACT_OR_EST_DELTA",
              "LOAD_TSP_ACT_DATETIME",
              "LOAD_TSP_EST_DATETIME",
              "LOAD_TSP_ACT_OR_EST_DATETIME",
              "LOAD_TSP_PLANNED_DATETIME",
              "LOAD_TSP_PLANNED_END_DATETIME",
              "LOAD_TSP_INIT_PLANNED_DATETIME",
              "LOAD_TSP_INIT_PLANNED_END_DATETIME",
              "LOAD_TSP_ACT_DELTA",
              "LOAD_TSP_EST_DELTA",
              "LOAD_TSP_ACT_OR_EST_DELTA",
              "DEPART_TSP_ACT_DATETIME",
              "DEPART_TSP_EST_DATETIME",
              "DEPART_TSP_ACT_OR_EST_DATETIME",
              "DEPART_TSP_PLANNED_DATETIME",
              "DEPART_TSP_PLANNED_END_DATETIME",
              "DEPART_TSP_INIT_PLANNED_DATETIME",
              "DEPART_TSP_INIT_PLANNED_END_DATETIME",
              "DEPART_TSP_ACT_DELTA",
              "DEPART_TSP_EST_DELTA",
              "DEPART_TSP_ACT_OR_EST_DELTA",
              "CUSTOMS_DOCS_FILING_POD_ACT_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_EST_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_ACT_OR_EST_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_PLANNED_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_PLANNED_END_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_INIT_PLANNED_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_INIT_PLANNED_END_DATETIME",
              "CUSTOMS_DOCS_FILING_POD_ACT_DELTA",
              "CUSTOMS_DOCS_FILING_POD_EST_DELTA",
              "CUSTOMS_DOCS_FILING_POD_ACT_OR_EST_DELTA",
              "CUSTOMS_CLEARANCE_POD_ACT_DATETIME",
              "CUSTOMS_CLEARANCE_POD_EST_DATETIME",
              "CUSTOMS_CLEARANCE_POD_ACT_OR_EST_DATETIME",
              "CUSTOMS_CLEARANCE_POD_PLANNED_DATETIME",
              "CUSTOMS_CLEARANCE_POD_PLANNED_END_DATETIME",
              "CUSTOMS_CLEARANCE_POD_INIT_PLANNED_DATETIME",
              "CUSTOMS_CLEARANCE_POD_INIT_PLANNED_END_DATETIME",
              "CUSTOMS_CLEARANCE_POD_ACT_DELTA",
              "CUSTOMS_CLEARANCE_POD_EST_DELTA",
              "CUSTOMS_CLEARANCE_POD_ACT_OR_EST_DELTA",
              "GATE_OUT_FULL_POD_ACT_DATETIME",
              "GATE_OUT_FULL_POD_EST_DATETIME",
              "GATE_OUT_FULL_POD_ACT_OR_EST_DATETIME",
              "GATE_OUT_FULL_POD_PLANNED_DATETIME",
              "GATE_OUT_FULL_POD_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_POD_INIT_PLANNED_DATETIME",
              "GATE_OUT_FULL_POD_INIT_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_POD_ACT_DELTA",
              "GATE_OUT_FULL_POD_EST_DELTA",
              "GATE_OUT_FULL_POD_ACT_OR_EST_DELTA",
              "GATE_IN_EMPTY_POD_ACT_DATETIME",
              "GATE_IN_EMPTY_POD_EST_DATETIME",
              "GATE_IN_EMPTY_POD_ACT_OR_EST_DATETIME",
              "GATE_IN_EMPTY_POD_PLANNED_DATETIME",
              "GATE_IN_EMPTY_POD_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_POD_INIT_PLANNED_DATETIME",
              "GATE_IN_EMPTY_POD_INIT_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_POD_ACT_DELTA",
              "GATE_IN_EMPTY_POD_EST_DELTA",
              "GATE_IN_EMPTY_POD_ACT_OR_EST_DELTA",
              "ARRIVE_POD_ACT_DATETIME",
              "ARRIVE_POD_EST_DATETIME",
              "ARRIVE_POD_ACT_OR_EST_DATETIME",
              "ARRIVE_POD_PLANNED_DATETIME",
              "ARRIVE_POD_PLANNED_END_DATETIME",
              "ARRIVE_POD_INIT_PLANNED_DATETIME",
              "ARRIVE_POD_INIT_PLANNED_END_DATETIME",
              "ARRIVE_POD_ACT_DELTA",
              "ARRIVE_POD_EST_DELTA",
              "ARRIVE_POD_ACT_OR_EST_DELTA",
              "ARRIVE_ABS_ORIGIN_ACT_DATETIME",
              "ARRIVE_ABS_ORIGIN_EST_DATETIME",
              "ARRIVE_ABS_ORIGIN_ACT_OR_EST_DATETIME",
              "ARRIVE_ABS_ORIGIN_PLANNED_DATETIME",
              "ARRIVE_ABS_ORIGIN_PLANNED_END_DATETIME",
              "ARRIVE_ABS_ORIGIN_INIT_PLANNED_DATETIME",
              "ARRIVE_ABS_ORIGIN_INIT_PLANNED_END_DATETIME",
              "ARRIVE_ABS_ORIGIN_ACT_DELTA",
              "ARRIVE_ABS_ORIGIN_EST_DELTA",
              "ARRIVE_ABS_ORIGIN_ACT_OR_EST_DELTA",
              "PICKUP_ABS_ORIGIN_ACT_DATETIME",
              "PICKUP_ABS_ORIGIN_EST_DATETIME",
              "PICKUP_ABS_ORIGIN_ACT_OR_EST_DATETIME",
              "PICKUP_ABS_ORIGIN_PLANNED_DATETIME",
              "PICKUP_ABS_ORIGIN_PLANNED_END_DATETIME",
              "PICKUP_ABS_ORIGIN_INIT_PLANNED_DATETIME",
              "PICKUP_ABS_ORIGIN_INIT_PLANNED_END_DATETIME",
              "PICKUP_ABS_ORIGIN_ACT_DELTA",
              "PICKUP_ABS_ORIGIN_EST_DELTA",
              "PICKUP_ABS_ORIGIN_ACT_OR_EST_DELTA",
              "ARRIVE_LAST_TRANSFER_ACT_DATETIME",
              "ARRIVE_LAST_TRANSFER_EST_DATETIME",
              "ARRIVE_LAST_TRANSFER_ACT_OR_EST_DATETIME",
              "ARRIVE_LAST_TRANSFER_PLANNED_DATETIME",
              "ARRIVE_LAST_TRANSFER_PLANNED_END_DATETIME",
              "ARRIVE_LAST_TRANSFER_INIT_PLANNED_DATETIME",
              "ARRIVE_LAST_TRANSFER_INIT_PLANNED_END_DATETIME",
              "ARRIVE_LAST_TRANSFER_ACT_DELTA",
              "ARRIVE_LAST_TRANSFER_EST_DELTA",
              "ARRIVE_LAST_TRANSFER_ACT_OR_EST_DELTA",
              "AVAILABLE_LAST_TRANSFER_ACT_DATETIME",
              "AVAILABLE_LAST_TRANSFER_EST_DATETIME",
              "AVAILABLE_LAST_TRANSFER_ACT_OR_EST_DATETIME",
              "AVAILABLE_LAST_TRANSFER_PLANNED_DATETIME",
              "AVAILABLE_LAST_TRANSFER_PLANNED_END_DATETIME",
              "AVAILABLE_LAST_TRANSFER_INIT_PLANNED_DATETIME",
              "AVAILABLE_LAST_TRANSFER_INIT_PLANNED_END_DATETIME",
              "AVAILABLE_LAST_TRANSFER_ACT_DELTA",
              "AVAILABLE_LAST_TRANSFER_EST_DELTA",
              "AVAILABLE_LAST_TRANSFER_ACT_OR_EST_DELTA",
              "GATE_IN_EMPTY_LAST_TRANSFER_ACT_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_EST_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_ACT_OR_EST_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_PLANNED_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_INIT_PLANNED_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_INIT_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_LAST_TRANSFER_ACT_DELTA",
              "GATE_IN_EMPTY_LAST_TRANSFER_EST_DELTA",
              "GATE_IN_EMPTY_LAST_TRANSFER_ACT_OR_EST_DELTA",
              "DEPART_LAST_TRANSFER_ACT_DATETIME",
              "DEPART_LAST_TRANSFER_EST_DATETIME",
              "DEPART_LAST_TRANSFER_ACT_OR_EST_DATETIME",
              "DEPART_LAST_TRANSFER_PLANNED_DATETIME",
              "DEPART_LAST_TRANSFER_PLANNED_END_DATETIME",
              "DEPART_LAST_TRANSFER_INIT_PLANNED_DATETIME",
              "DEPART_LAST_TRANSFER_INIT_PLANNED_END_DATETIME",
              "DEPART_LAST_TRANSFER_ACT_DELTA",
              "DEPART_LAST_TRANSFER_EST_DELTA",
              "DEPART_LAST_TRANSFER_ACT_OR_EST_DELTA",
              "IMPORT_DEMURRAGE_COST",
              "IMPORT_DEMURRAGE_TIER",
              "IMPORT_DETENTION_COST",
              "IMPORT_DETENTION_TIER",
              "EXPORT_DEMURRAGE_COST",
              "EXPORT_DEMURRAGE_TIER",
              "EXPORT_DETENTION_COST",
              "EXPORT_DETENTION_TIER",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_ACT_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_EST_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_ACT_OR_EST_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_PLANNED_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_PLANNED_END_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_INIT_PLANNED_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_ACT_DELTA",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_EST_DELTA",
              "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL_ACT_OR_EST_DELTA",
              "BOOKING_CONFIRMED_BY_FFW_ACT_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_EST_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_ACT_OR_EST_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_PLANNED_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_PLANNED_END_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_INIT_PLANNED_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_INIT_PLANNED_END_DATETIME",
              "BOOKING_CONFIRMED_BY_FFW_ACT_DELTA",
              "BOOKING_CONFIRMED_BY_FFW_EST_DELTA",
              "BOOKING_CONFIRMED_BY_FFW_ACT_OR_EST_DELTA",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_ACT_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_EST_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_ACT_OR_EST_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_PLANNED_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_PLANNED_END_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_INIT_PLANNED_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_INIT_PLANNED_END_DATETIME",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_ACT_DELTA",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_EST_DELTA",
              "BOOKING_CONFIRMED_BY_OCEAN_CARRIER_ACT_OR_EST_DELTA",
              "BOOKING_CANCELLED_ACT_DATETIME",
              "BOOKING_CANCELLED_EST_DATETIME",
              "BOOKING_CANCELLED_ACT_OR_EST_DATETIME",
              "BOOKING_CANCELLED_PLANNED_DATETIME",
              "BOOKING_CANCELLED_PLANNED_END_DATETIME",
              "BOOKING_CANCELLED_INIT_PLANNED_DATETIME",
              "BOOKING_CANCELLED_INIT_PLANNED_END_DATETIME",
              "BOOKING_CANCELLED_ACT_DELTA",
              "BOOKING_CANCELLED_EST_DELTA",
              "BOOKING_CANCELLED_ACT_OR_EST_DELTA",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_ACT_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_EST_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_ACT_OR_EST_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_PLANNED_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_PLANNED_END_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_INIT_PLANNED_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_ACT_DELTA",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_EST_DELTA",
              "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN_ACT_OR_EST_DELTA",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_ACT_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_EST_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_ACT_OR_EST_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_PLANNED_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_PLANNED_END_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_INIT_PLANNED_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_INIT_PLANNED_END_DATETIME",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_ACT_DELTA",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_EST_DELTA",
              "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN_ACT_OR_EST_DELTA",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_ACT_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_EST_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_ACT_OR_EST_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_PLANNED_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_PLANNED_END_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_INIT_PLANNED_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_INIT_PLANNED_END_DATETIME",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_ACT_DELTA",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_EST_DELTA",
              "PICKED_UP_FULL_CONTAINER_AT_ORIGIN_ACT_OR_EST_DELTA",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_ACT_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_EST_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_ACT_OR_EST_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_PLANNED_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_PLANNED_END_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_INIT_PLANNED_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_ACT_DELTA",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_EST_DELTA",
              "ARRIVAL_AT_EXPORT_WAREHOUSE_ACT_OR_EST_DELTA",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_ACT_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_EST_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_ACT_OR_EST_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_PLANNED_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_INIT_PLANNED_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_ACT_DELTA",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_EST_DELTA",
              "DEPARTURE_FROM_EXPORT_WAREHOUSE_ACT_OR_EST_DELTA",
              "ARRIVAL_AT_ORIGIN_CFS_ACT_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_EST_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_ACT_OR_EST_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_PLANNED_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_PLANNED_END_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_INIT_PLANNED_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_AT_ORIGIN_CFS_ACT_DELTA",
              "ARRIVAL_AT_ORIGIN_CFS_EST_DELTA",
              "ARRIVAL_AT_ORIGIN_CFS_ACT_OR_EST_DELTA",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_ACT_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_EST_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_ACT_OR_EST_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_PLANNED_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_PLANNED_END_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_INIT_PLANNED_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_INIT_PLANNED_END_DATETIME",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_ACT_DELTA",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_EST_DELTA",
              "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS_ACT_OR_EST_DELTA",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_ACT_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_EST_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_ACT_OR_EST_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_PLANNED_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_PLANNED_END_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_INIT_PLANNED_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_ACT_DELTA",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_EST_DELTA",
              "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS_ACT_OR_EST_DELTA",
              "EXPORT_CUSTOMS_DOCS_FILING_ACT_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_EST_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_ACT_OR_EST_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_INIT_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_INIT_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_DOCS_FILING_ACT_DELTA",
              "EXPORT_CUSTOMS_DOCS_FILING_EST_DELTA",
              "EXPORT_CUSTOMS_DOCS_FILING_ACT_OR_EST_DELTA",
              "EXPORT_CUSTOMS_HOLD_ACT_DATETIME",
              "EXPORT_CUSTOMS_HOLD_EST_DATETIME",
              "EXPORT_CUSTOMS_HOLD_ACT_OR_EST_DATETIME",
              "EXPORT_CUSTOMS_HOLD_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_HOLD_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_HOLD_INIT_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_HOLD_INIT_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_HOLD_ACT_DELTA",
              "EXPORT_CUSTOMS_HOLD_EST_DELTA",
              "EXPORT_CUSTOMS_HOLD_ACT_OR_EST_DELTA",
              "EXPORT_CUSTOMS_CLEARANCE_ACT_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_EST_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_ACT_OR_EST_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_INIT_PLANNED_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_INIT_PLANNED_END_DATETIME",
              "EXPORT_CUSTOMS_CLEARANCE_ACT_DELTA",
              "EXPORT_CUSTOMS_CLEARANCE_EST_DELTA",
              "EXPORT_CUSTOMS_CLEARANCE_ACT_OR_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_EST_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_ACT_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_EST_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_PLANNED_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_PLANNED_END_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_ACT_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_EST_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL_ACT_OR_EST_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_ACT_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_EST_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_ACT_OR_EST_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_PLANNED_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_PLANNED_END_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_INIT_PLANNED_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_INIT_PLANNED_END_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_ACT_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_EST_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING_ACT_OR_EST_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_ACT_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_EST_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_ACT_OR_EST_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_INIT_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_INIT_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_ACT_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_EST_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING_ACT_OR_EST_DELTA",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_ACT_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_EST_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_ACT_OR_EST_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_PLANNED_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_PLANNED_END_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_INIT_PLANNED_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_INIT_PLANNED_END_DATETIME",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_ACT_DELTA",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_EST_DELTA",
              "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING_ACT_OR_EST_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_ACT_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_EST_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_ACT_OR_EST_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_INIT_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_INIT_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_ACT_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_EST_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_LOADING_ACT_OR_EST_DELTA",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_ACT_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_EST_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_PLANNED_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_PLANNED_END_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_ACT_DELTA",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_EST_DELTA",
              "ARRIVAL_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DELTA",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_ACT_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_EST_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_PLANNED_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_PLANNED_END_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_ACT_DELTA",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_EST_DELTA",
              "DISCHARGE_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DELTA",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_ACT_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_EST_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_PLANNED_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_PLANNED_END_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_INIT_PLANNED_END_DATETIME",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_ACT_DELTA",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_EST_DELTA",
              "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS_ACT_OR_EST_DELTA",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_ACT_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_EST_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_ACT_OR_EST_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_PLANNED_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_INIT_PLANNED_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_ACT_DELTA",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_EST_DELTA",
              "DEPARTURE_FROM_TRANSSHIPMENT_CFS_ACT_OR_EST_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_EST_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_ACT_DELTA",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_EST_DELTA",
              "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_ACT_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_EST_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_INIT_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_ACT_DELTA",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_EST_DELTA",
              "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT_ACT_OR_EST_DELTA",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "CARRIER_HOLD_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DELTA",
              "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_ACT_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_EST_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_INIT_PLANNED_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_INIT_PLANNED_END_DATETIME",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_ACT_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_EST_DELTA",
              "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE_ACT_OR_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_EST_DELTA",
              "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_ACT_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_EST_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_PLANNED_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_PLANNED_END_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_INIT_PLANNED_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_ACT_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_EST_DELTA",
              "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL_ACT_OR_EST_DELTA",
              "IMPORT_CUSTOMS_DOCS_FILING_ACT_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_EST_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_ACT_OR_EST_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_INIT_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_INIT_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_DOCS_FILING_ACT_DELTA",
              "IMPORT_CUSTOMS_DOCS_FILING_EST_DELTA",
              "IMPORT_CUSTOMS_DOCS_FILING_ACT_OR_EST_DELTA",
              "IMPORT_CUSTOMS_HOLD_ACT_DATETIME",
              "IMPORT_CUSTOMS_HOLD_EST_DATETIME",
              "IMPORT_CUSTOMS_HOLD_ACT_OR_EST_DATETIME",
              "IMPORT_CUSTOMS_HOLD_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_HOLD_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_HOLD_INIT_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_HOLD_INIT_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_HOLD_ACT_DELTA",
              "IMPORT_CUSTOMS_HOLD_EST_DELTA",
              "IMPORT_CUSTOMS_HOLD_ACT_OR_EST_DELTA",
              "IMPORT_CUSTOMS_CLEARANCE_ACT_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_EST_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_ACT_OR_EST_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_INIT_PLANNED_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_INIT_PLANNED_END_DATETIME",
              "IMPORT_CUSTOMS_CLEARANCE_ACT_DELTA",
              "IMPORT_CUSTOMS_CLEARANCE_EST_DELTA",
              "IMPORT_CUSTOMS_CLEARANCE_ACT_OR_EST_DELTA",
              "ARRIVAL_AT_DESTINATION_CFS_ACT_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_EST_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_ACT_OR_EST_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_PLANNED_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_PLANNED_END_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_INIT_PLANNED_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_AT_DESTINATION_CFS_ACT_DELTA",
              "ARRIVAL_AT_DESTINATION_CFS_EST_DELTA",
              "ARRIVAL_AT_DESTINATION_CFS_ACT_OR_EST_DELTA",
              "STRIP_AT_DESTINATION_CFS_ACT_DATETIME",
              "STRIP_AT_DESTINATION_CFS_EST_DATETIME",
              "STRIP_AT_DESTINATION_CFS_ACT_OR_EST_DATETIME",
              "STRIP_AT_DESTINATION_CFS_PLANNED_DATETIME",
              "STRIP_AT_DESTINATION_CFS_PLANNED_END_DATETIME",
              "STRIP_AT_DESTINATION_CFS_INIT_PLANNED_DATETIME",
              "STRIP_AT_DESTINATION_CFS_INIT_PLANNED_END_DATETIME",
              "STRIP_AT_DESTINATION_CFS_ACT_DELTA",
              "STRIP_AT_DESTINATION_CFS_EST_DELTA",
              "STRIP_AT_DESTINATION_CFS_ACT_OR_EST_DELTA",
              "DEPARTURE_FROM_DESTINATION_CFS_ACT_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_EST_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_ACT_OR_EST_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_PLANNED_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_INIT_PLANNED_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_DESTINATION_CFS_ACT_DELTA",
              "DEPARTURE_FROM_DESTINATION_CFS_EST_DELTA",
              "DEPARTURE_FROM_DESTINATION_CFS_ACT_OR_EST_DELTA",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_ACT_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_EST_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_ACT_OR_EST_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_PLANNED_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_PLANNED_END_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_INIT_PLANNED_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_ACT_DELTA",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_EST_DELTA",
              "ARRIVAL_AT_IMPORT_WAREHOUSE_ACT_OR_EST_DELTA",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_ACT_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_EST_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_ACT_OR_EST_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_PLANNED_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_INIT_PLANNED_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_INIT_PLANNED_END_DATETIME",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_ACT_DELTA",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_EST_DELTA",
              "DEPARTURE_FROM_IMPORT_WAREHOUSE_ACT_OR_EST_DELTA",
              "OUT_FOR_DELIVERY_ACT_DATETIME",
              "OUT_FOR_DELIVERY_EST_DATETIME",
              "OUT_FOR_DELIVERY_ACT_OR_EST_DATETIME",
              "OUT_FOR_DELIVERY_PLANNED_DATETIME",
              "OUT_FOR_DELIVERY_PLANNED_END_DATETIME",
              "OUT_FOR_DELIVERY_INIT_PLANNED_DATETIME",
              "OUT_FOR_DELIVERY_INIT_PLANNED_END_DATETIME",
              "OUT_FOR_DELIVERY_ACT_DELTA",
              "OUT_FOR_DELIVERY_EST_DELTA",
              "OUT_FOR_DELIVERY_ACT_OR_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_ACT_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_ACT_OR_EST_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_INIT_PLANNED_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_INIT_PLANNED_END_DATETIME",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_ACT_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_EST_DELTA",
              "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE_ACT_OR_EST_DELTA",
              "PROOF_OF_DELIVERY_ACT_DATETIME",
              "PROOF_OF_DELIVERY_EST_DATETIME",
              "PROOF_OF_DELIVERY_ACT_OR_EST_DATETIME",
              "PROOF_OF_DELIVERY_PLANNED_DATETIME",
              "PROOF_OF_DELIVERY_PLANNED_END_DATETIME",
              "PROOF_OF_DELIVERY_INIT_PLANNED_DATETIME",
              "PROOF_OF_DELIVERY_INIT_PLANNED_END_DATETIME",
              "PROOF_OF_DELIVERY_ACT_DELTA",
              "PROOF_OF_DELIVERY_EST_DELTA",
              "PROOF_OF_DELIVERY_ACT_OR_EST_DELTA",
              "HANDOVER_TO_THIRD_PARTY_ACT_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_EST_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_ACT_OR_EST_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_PLANNED_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_PLANNED_END_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_INIT_PLANNED_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_INIT_PLANNED_END_DATETIME",
              "HANDOVER_TO_THIRD_PARTY_ACT_DELTA",
              "HANDOVER_TO_THIRD_PARTY_EST_DELTA",
              "HANDOVER_TO_THIRD_PARTY_ACT_OR_EST_DELTA",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_ACT_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_EST_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_ACT_OR_EST_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_PLANNED_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_PLANNED_END_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_INIT_PLANNED_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_INIT_PLANNED_END_DATETIME",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_ACT_DELTA",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_EST_DELTA",
              "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION_ACT_OR_EST_DELTA",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_ACT_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_EST_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_ACT_OR_EST_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_PLANNED_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_PLANNED_END_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_INIT_PLANNED_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_INIT_PLANNED_END_DATETIME",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_ACT_DELTA",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_EST_DELTA",
              "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE_ACT_OR_EST_DELTA",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_ACT_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_EST_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_ACT_OR_EST_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_PLANNED_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_INIT_PLANNED_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_INIT_PLANNED_END_DATETIME",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_ACT_DELTA",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_EST_DELTA",
              "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL_ACT_OR_EST_DELTA"
            ]
          },
          "milestoneField": {
            "$ref": "#/components/schemas/ShipmentMilestoneSortField"
          }
        },
        "description": "Exactly one of [fieldName, milestoneField] must be provided."
      },
      "ShipmentStateFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "UNKNOWN",
                "AT_STOP",
                "IN_TRANSIT_AIRCRAFT",
                "IN_TRANSIT_VESSEL",
                "IN_TRANSIT_RAIL",
                "CUSTOMS_HOLD",
                "IN_TRANSIT",
                "COMPLETED",
                "SCHEDULED",
                "IDLE",
                "ACTION_REQUIRED"
              ]
            }
          }
        },
        "description": "Match shipments based on the current state.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (currentState.type EQUALS [A OR B OR C])\n\nExample: (currentState.type NOT_EQUALS A) AND (currentState.type NOT_EQUALS B)"
      },
      "ShipmentStopFilter": {
        "type": "object",
        "properties": {
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifierCriterion"
            }
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LocationCriterion"
            }
          },
          "stopType": {
            "$ref": "#/components/schemas/StopTypeCriterion"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ANY_INBOUND",
                "ANY_OUTBOUND",
                "CURRENT",
                "ANY_STOP",
                "EVERY_STOP",
                "ORIGIN",
                "DESTINATION",
                "EVENTS",
                "LATEST_ACTUAL_EVENT"
              ]
            }
          }
        },
        "description": "Match shipments using a collection of stop-related and location-related criteria. All provided criteria within are combined using an AND operator."
      },
      "ShipmentSummary": {
        "type": "object",
        "properties": {
          "allShipmentIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "activeVehicleIdentifier": {
            "$ref": "#/components/schemas/VehicleShipmentIdentifier"
          },
          "allActiveVehicleIdentifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VehicleShipmentIdentifier"
            }
          },
          "activeSegmentMode": {
            "type": "string",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ]
          },
          "allSegmentModes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "AIR",
                "OCEAN",
                "RAIL",
                "UNKNOWN",
                "TRUCKLOAD",
                "PARCEL",
                "LTL",
                "BARGE"
              ]
            }
          },
          "accessGroupIds": {
            "uniqueItems": true,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "completedDateTime": {
            "type": "string",
            "description": "The date and time at which the shipment was completed.",
            "format": "date-time"
          },
          "currentState": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "AT_STOP",
              "IN_TRANSIT_AIRCRAFT",
              "IN_TRANSIT_VESSEL",
              "IN_TRANSIT_RAIL",
              "CUSTOMS_HOLD",
              "IN_TRANSIT",
              "COMPLETED",
              "SCHEDULED",
              "IDLE",
              "ACTION_REQUIRED"
            ]
          },
          "currentStopLocation": {
            "$ref": "#/components/schemas/TrackedShipmentStopLocation"
          },
          "carrier": {
            "type": "string"
          },
          "costs": {
            "type": "array",
            "description": "A collection of charges or fees incurred by this shipment or one of its related assets.",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentCost"
            }
          },
          "customAttributes": {
            "type": "array",
            "description": "A collection of custom attributes on the shipment. This is only populated if requested through additionalFields.",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "destinationLocation": {
            "$ref": "#/components/schemas/TrackedShipmentStopLocation"
          },
          "emissions": {
            "$ref": "#/components/schemas/EmissionData"
          },
          "exceptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentExceptionSummary"
            }
          },
          "latestTrackingStatusEvent": {
            "$ref": "#/components/schemas/TrackingStatusEvent"
          },
          "lastKnownPosition": {
            "$ref": "#/components/schemas/TrackedShipmentPosition"
          },
          "milestones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentMilestone"
            }
          },
          "originLocation": {
            "$ref": "#/components/schemas/TrackedShipmentStopLocation"
          },
          "primaryShipmentIdentifier": {
            "$ref": "#/components/schemas/PrimaryShipmentIdentifier"
          },
          "relatedOrders": {
            "type": "array",
            "description": "A collection of orders fulfilled by this shipment.",
            "items": {
              "$ref": "#/components/schemas/ShipmentOrder"
            }
          },
          "shipmentId": {
            "type": "string",
            "format": "uuid"
          },
          "stops": {
            "type": "array",
            "description": "A collection of stops along the shipment's route, in the order in which they appear in the route. This is only populated if requested through additionalFields.",
            "items": {
              "$ref": "#/components/schemas/ShipmentSummaryStop"
            }
          },
          "sharingContext": {
            "$ref": "#/components/schemas/SharingContext"
          },
          "transitTime": {
            "$ref": "#/components/schemas/ForecastableTimeDuration"
          },
          "updatedDateTime": {
            "type": "string",
            "format": "date-time"
          }
        },
        "description": "Condensed shipment information intended to represent a row in a list of search results."
      },
      "ShipmentSummaryPage": {
        "type": "object",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "type": "array",
            "description": "List of resources contained on this page.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/ShipmentSummary"
            }
          }
        }
      },
      "ShipmentSummaryStop": {
        "required": [],
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "description": "A collection of events that have occurred or are expected to occur at this stop.",
            "items": {
              "$ref": "#/components/schemas/ShipmentSummaryStopEvent"
            }
          },
          "stop": {
            "$ref": "#/components/schemas/TrackedShipmentStop"
          },
          "significance": {
            "type": "array",
            "description": "The significance of the stop to the lifecycle of the shipment, such as the absolute origin or destination.",
            "items": {
              "type": "string",
              "description": "The significance of the stop to the lifecycle of the shipment, such as the absolute origin or destination.",
              "enum": [
                "UNKNOWN",
                "ABSOLUTE_ORIGIN",
                "ABSOLUTE_DESTINATION",
                "FIRST_PORT_OF_LOADING",
                "LAST_PORT_OF_DISCHARGE",
                "FIRST_TRANSSHIPMENT_PORT",
                "ANY_TRANSSHIPMENT_PORT",
                "LAST_TRANSFER",
                "EMPTY_CONTAINER_PICKUP",
                "EMPTY_CONTAINER_RETURN"
              ]
            }
          }
        },
        "description": "A stop along a shipment's route, including its sequence in the route and any events that may occur at the stop."
      },
      "ShipmentSummaryStopEvent": {
        "required": [],
        "type": "object",
        "properties": {
          "actualOrEstimateDateTime": {
            "$ref": "#/components/schemas/TrackedShipmentDateTime"
          },
          "carrierInitialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the carrier expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "carrierInitialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the carrier expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "carrierLatestPlannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the carrier expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "carrierLatestPlannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the carrier expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "customerInitialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the customer expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "customerInitialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the customer expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "customerLatestPlannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the customer expects the event to occur. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "customerLatestPlannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the customer expects the event to occur. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "description": {
            "type": "string",
            "description": "The description of the event."
          },
          "dateTime": {
            "type": "string",
            "description": "The date and time when the event occurred.",
            "format": "date-time"
          },
          "deltaEstimatedInMinutes": {
            "type": "integer",
            "description": "The difference in time, in minutes, between the planned time of this event and its estimated time.\n\nA positive value represents later than planned; a negative value represents earlier than planned.\n\nThis field will only be populated if both planned time and estimated time exist. It may be populated even after the event has occurred.",
            "format": "int64"
          },
          "deltaActualInMinutes": {
            "type": "integer",
            "description": "The difference in time, in minutes, between the planned time of this event and its actual time.\n\nA positive value represents later than planned; a negative value represents earlier than planned.\n\nThis field will only be populated if both planned time and estimated time exist. It may be populated even after the event has occurred.",
            "format": "int64"
          },
          "deltaActualOrEstimatedInMinutes": {
            "type": "integer",
            "description": "Represents the difference in time, in minutes, between the planned time and the actual time if the event has occurred. Otherwise, represents the difference in time, in minutes, between the planned time and the estimated time.",
            "format": "int64"
          },
          "details": {
            "$ref": "#/components/schemas/ShipmentEventDetails"
          },
          "estimateDateTime": {
            "$ref": "#/components/schemas/TrackedShipmentDateTime"
          },
          "initialPlannedDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the event occurred. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "initialPlannedEndDateTime": {
            "type": "string",
            "description": "The initial planned date and time when the event occurred. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "latestPlannedDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the event occurred. If the planned time is a range, this is the start of the range.",
            "format": "date-time"
          },
          "latestPlannedEndDateTime": {
            "type": "string",
            "description": "The latest planned date and time when the event occurred. This field is only populated when the planned time is a range; it represents the end of the range.",
            "format": "date-time"
          },
          "receivedDateTime": {
            "type": "string",
            "description": "The date and time when the event was received by the system.",
            "format": "date-time"
          },
          "significance": {
            "type": "array",
            "description": "The significance of the event to the lifecycle of the shipment, such as pick-up from origin or delivery at destination.",
            "items": {
              "type": "string",
              "description": "The significance of the event to the lifecycle of the shipment, such as pick-up from origin or delivery at destination.",
              "enum": [
                "UNKNOWN",
                "GATE_OUT_EMPTY_AT_FIRST_PORT",
                "GATE_IN_FULL_AT_FIRST_PORT",
                "CUSTOMS_DOCS_FILING_AT_FIRST_PORT",
                "CUSTOMS_CLEARANCE_AT_FIRST_PORT",
                "LOAD_AT_FIRST_PORT",
                "DEPARTURE_FROM_FIRST_PORT",
                "CUSTOMS_DOCS_FILING_AT_LAST_PORT",
                "CUSTOMS_CLEARANCE_AT_LAST_PORT",
                "GATE_OUT_FULL_AT_LAST_PORT",
                "GATE_IN_EMPTY_AT_LAST_PORT",
                "ARRIVAL_AT_LAST_PORT",
                "DISCHARGE_AT_LAST_PORT",
                "RECEIVE_FROM_CARRIER_AT_LAST_PORT",
                "LAST_FREE_DAY_DEMURRAGE_AT_LAST_PORT",
                "LAST_FREE_DAY_DETENTION_AT_LAST_PORT",
                "ARRIVAL_AT_ABSOLUTE_ORIGIN",
                "PICKED_UP_AT_ABSOLUTE_ORIGIN",
                "DEPARTURE_FROM_ABSOLUTE_ORIGIN",
                "ARRIVAL_AT_ABSOLUTE_DESTINATION",
                "DELIVERY_AT_ABSOLUTE_DESTINATION",
                "ARRIVAL_AT_FIRST_TRANSSHIPMENT_PORT",
                "DISCHARGE_AT_FIRST_TRANSSHIPMENT_PORT",
                "LOAD_AT_FIRST_TRANSSHIPMENT_PORT",
                "DEPART_FROM_FIRST_TRANSSHIPMENT_PORT",
                "ARRIVAL_AT_ANY_TRANSSHIPMENT_PORT",
                "DISCHARGE_AT_ANY_TRANSSHIPMENT_PORT",
                "LOAD_AT_ANY_TRANSSHIPMENT_PORT",
                "DEPART_FROM_ANY_TRANSSHIPMENT_PORT",
                "ARRIVAL_AT_LAST_TRANSFER",
                "AVAILABLE_AT_LAST_TRANSFER",
                "GATE_IN_EMPTY_AT_LAST_TRANSFER",
                "DEPARTURE_FROM_LAST_TRANSFER",
                "HELD_CUSTOM_HOLD_CARRIER_HOLD",
                "GATE_OUT_EMPTY_CONTAINER_AT_TERMINAL",
                "BOOKING_CONFIRMED_BY_FFW",
                "BOOKING_CONFIRMED_BY_OCEAN_CARRIER",
                "BOOKING_CANCELLED",
                "ARRIVAL_OF_EMPTY_CONTAINER_AT_ORIGIN",
                "FULL_CONTAINER_READY_FOR_PICK_UP_AT_ORIGIN",
                "PICKED_UP_FULL_CONTAINER_AT_ORIGIN",
                "ARRIVAL_AT_EXPORT_WAREHOUSE",
                "DEPARTURE_FROM_EXPORT_WAREHOUSE",
                "ARRIVAL_AT_ORIGIN_CFS",
                "LOAD_INTO_CONTAINER_AT_ORIGIN_CFS",
                "DEPARTURE_OF_CONTAINER_FROM_ORIGIN_CFS",
                "EXPORT_CUSTOMS_DOCS_FILING",
                "EXPORT_CUSTOMS_HOLD",
                "EXPORT_CUSTOMS_CLEARANCE",
                "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
                "DISCHARGE_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
                "LOAD_FULL_CONTAINER_AT_INLAND_EXPORT_TERMINAL",
                "DEPARTURE_FULL_CONTAINER_FROM_INLAND_EXPORT_TERMINAL",
                "GATE_IN_FULL_CONTAINER_AT_PORT_OF_LOADING",
                "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_PORT_OF_LOADING",
                "VESSEL_DEPARTURE_FROM_PORT_OF_LOADING",
                "SHORT_SHIPPED_AT_PORT_OF_LOADING",
                "VESSEL_ARRIVAL_AT_TRANSSHIPMENT_PORT",
                "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_TRANSSHIPMENT_PORT",
                "ARRIVAL_AT_TRANSSHIPMENT_CFS",
                "DISCHARGE_AT_TRANSSHIPMENT_CFS",
                "LOAD_INTO_CONTAINER_AT_TRANSSHIPMENT_CFS",
                "DEPARTURE_FROM_TRANSSHIPMENT_CFS",
                "LOAD_FULL_CONTAINER_ONTO_VESSEL_AT_TRANSSHIPMENT_PORT",
                "GATE_OUT_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
                "GATE_IN_FULL_CONTAINER_AT_TRANSSHIPMENT_PORT",
                "VESSEL_DEPARTURE_FROM_TRANSSHIPMENT_PORT",
                "SHORT_SHIPPED_AT_TRANSSHIPMENT_PORT",
                "VESSEL_ARRIVAL_AT_PORT_OF_DISCHARGE",
                "DISCHARGE_FULL_CONTAINER_FROM_VESSEL_AT_PORT_OF_DISCHARGE",
                "CARRIER_HOLD_AT_PORT_OF_DISCHARGE",
                "CARRIER_RELEASE_AT_PORT_OF_DISCHARGE",
                "GATE_OUT_FULL_CONTAINER_AT_PORT_OF_DISCHARGE",
                "DISCHARGE_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
                "SHORT_SHIPPED_AT_PORT_OF_DISCHARGE",
                "ARRIVAL_OF_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
                "LOAD_FULL_CONTAINER_AT_INLAND_IMPORT_TERMINAL",
                "DEPARTURE_FULL_CONTAINER_FROM_INLAND_IMPORT_TERMINAL",
                "IMPORT_CUSTOMS_DOCS_FILING",
                "IMPORT_CUSTOMS_HOLD",
                "IMPORT_CUSTOMS_CLEARANCE",
                "ARRIVAL_AT_DESTINATION_CFS",
                "STRIP_AT_DESTINATION_CFS",
                "DEPARTURE_FROM_DESTINATION_CFS",
                "ARRIVAL_AT_IMPORT_WAREHOUSE",
                "DEPARTURE_FROM_IMPORT_WAREHOUSE",
                "OUT_FOR_DELIVERY",
                "ARRIVAL_OF_FULL_CONTAINER_AT_CONSIGNEE",
                "PROOF_OF_DELIVERY",
                "HANDOVER_TO_THIRD_PARTY",
                "READY_FOR_PICKUP_EMPTY_CONTAINER_AT_CONSIGNEE_LOCATION",
                "PICKED_UP_EMPTY_CONTAINER_FROM_CONSIGNEE",
                "GATE_IN_EMPTY_CONTAINER_AT_TERMINAL"
              ]
            }
          },
          "type": {
            "type": "string",
            "description": "The type of the event.",
            "enum": [
              "UNKNOWN",
              "TRACKING_INITIATE",
              "TRACKING_START",
              "ARRIVAL_AT_STOP",
              "DEPARTURE_FROM_STOP",
              "LOAD_ONTO_VEHICLE",
              "UNLOAD_FROM_VEHICLE",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_END_BY_USER",
              "TRACKING_COMPLETE",
              "GATE_IN",
              "GATE_OUT",
              "FLIGHT_BOOKING",
              "MANIFEST",
              "RECEIVE_FROM_SHIPPER",
              "CONSIGNEE_NOTIFY",
              "DELIVERY",
              "WARNING",
              "EXCEPTION",
              "TRACKING_STOP",
              "EXCEPTION_LATE_DEPARTURE",
              "EXCEPTION_MISSED_CONNECTION",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT_FULL",
              "LOAD",
              "DISCHARGE",
              "EXCEPTION_DELAYED",
              "EXCEPTION_DELIVERY_MISSED",
              "EXCEPTION_HELD",
              "EXCEPTION_PICKUP_MISSED",
              "AVAILABLE",
              "ENTERED_GEOFENCE",
              "EXITED_GEOFENCE",
              "INFO",
              "OUT_FOR_DELIVERY",
              "PICKED_UP",
              "RETURN_TO_SENDER",
              "TRACKING_FAILED",
              "UNAUTHORIZED",
              "PICKUP_MISSED",
              "SURVEY",
              "HELD",
              "RELEASE",
              "DELAYED",
              "DELIVERY_MISSED",
              "ENTERED_INNER_GEOFENCE",
              "EXITED_INNER_GEOFENCE",
              "ENTERED_OUTER_GEOFENCE",
              "EXITED_OUTER_GEOFENCE",
              "ENTERED_FINAL_GEOFENCE",
              "EXITED_FINAL_GEOFENCE",
              "IDLE",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "DISPATCH",
              "CUSTOMS_HOLD",
              "CUSTOMS_CLEARANCE",
              "CUSTOMS_DOCS_FILING",
              "CUSTOMS_TRANSIT_DOCS_ISSUED",
              "CUSTOMS_TRANSIT_DOCS_CLOSED",
              "CARRIER_HOLD",
              "RECEIVE_FROM_CARRIER",
              "ISSUE_FREIGHT_BILL",
              "FREIGHT_ON_HAND",
              "READY_FOR_CARRIAGE",
              "LAST_FREE_DAY",
              "MISSING_CARRIER",
              "STUFF",
              "STRIP",
              "SEAL_INSPECTION",
              "SEAL_REMOVAL",
              "SEAL_RESEAL",
              "HANDOVER",
              "DOCUMENT_ADD",
              "DOCUMENT_REMOVE",
              "REMOVE_FROM_BOOKING",
              "COST_UPDATE",
              "SHARING_STOPPED",
              "ROLLED_OVER",
              "BAD_ORDER",
              "BAD_ORDER_RELEASE"
            ]
          }
        },
        "description": "An event that has occurred at a stop along a shipment's route. This is intended to be a component of shipment stop information and therefore does not repeat stop and segment info."
      },
      "ShipmentTenantAttribute": {
        "properties": {
          "attributeName": {
            "type": "string"
          },
          "attributeValues": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "ShipmentTenantAttribute",
        "type": "object"
      },
      "ShipmentTotals": {
        "type": "object",
        "properties": {
          "cube": {
            "type": "integer",
            "description": "Cubic volume of the entire shipment (total length X total width X total height)."
          },
          "cubeDimensionsUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShipmentTotalsDimensionsUnitCode"
              }
            ],
            "description": "The unit of measurement for cubic dimensions. Defaults to Feet (Imperial) if not passed.Valid Values: Feet or Meters.",
            "default": "Feet"
          },
          "currency": {
            "type": "string",
            "description": "Optional attribute to indicate currency of declaredValue. Defaults to USD."
          },
          "dimensionsUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DimensionsUnit"
              }
            ],
            "description": "The unit of measurement for dimensions. Defaults to Inches (Imperial) if not passed.Valid Values: Inches or Centimeters.",
            "default": "Inches"
          },
          "declaredValue": {
            "type": "integer",
            "description": "Total monetary value of the shipment in USD (sometimes needed for cross-border moves)."
          },
          "grossWeight": {
            "type": "integer",
            "description": "Total weight of the entire shipment, including handling units (tare weight)."
          },
          "handlingUnits": {
            "type": "integer",
            "description": "Handling unit count for the entire shipment."
          },
          "linearLength": {
            "type": "integer",
            "description": "Linear length for the entire shipment."
          },
          "netWeight": {
            "type": "integer",
            "description": "Total weight of the entire shipment, not including handling units (tare weight)."
          },
          "weightUnit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingEBOLWeightUnit"
              }
            ],
            "description": "The unit of measurement for weight. Defaults to Pounds (Imperial) if not passed.Valid Values: Pounds or Kilograms.",
            "default": "Pounds"
          }
        }
      },
      "ShipmentTotalsDimensionsUnitCode": {
        "enum": [
          "Feet",
          "Meters"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "ShipmentTrackingStatusEventFilter": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "LATEST"
              ]
            }
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "TRACKING_INITIATE",
                "TRACKING_START",
                "TRACKING_END_BY_USER",
                "TRACKING_END_DUE_TO_TIMEOUT",
                "TRACKING_FAILED",
                "TRACKING_COMPLETE",
                "TRACKING_STOP",
                "DRIVER_DENY_TRACKING",
                "UNKNOWN_EQUIPMENT_IDENTIFIER",
                "MISSING_EQUIPMENT_IDENTIFIER",
                "REMOVE_FROM_BOOKING",
                "SHARING_STOPPED",
                "UNKNOWN"
              ]
            }
          }
        },
        "description": "Match shipments based on the tracking status. By default, the criterion can be satisfied by any (current or historical) tracking status events. To limit the scope of this check, use the scopes field. Omit the scopes field to search all scopes.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (events.type EQUALS [A OR B OR C])\n\nExample: (events.type NOT_EQUALS A) AND (events.type NOT_EQUALS B)"
      },
      "ShippingDetails": {
        "type": "object",
        "properties": {
          "air": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AirDetails"
              }
            ],
            "description": "Air equipment details."
          },
          "ltl": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LtlDetails"
              }
            ],
            "description": "Ltl related shipment details"
          },
          "ocean": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OceanDetails"
              }
            ],
            "description": "Ocean equipment details."
          },
          "truck": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TruckDetails"
              }
            ],
            "description": "Truck equipment details."
          },
          "volumeLtl": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeLtlDetails"
              }
            ],
            "description": "Volume Ltl related shipment details"
          }
        }
      },
      "ShippingLabels": {
        "required": [],
        "type": "object",
        "properties": {
          "format": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ShippingLabelsFormat"
              }
            ],
            "description": "Specifies the printer format type for the labels. Example: Avery."
          },
          "position": {
            "type": "integer",
            "description": "Specifies the starting position for the shipping labels. Valid Values: 1 - 6 ."
          },
          "quantity": {
            "type": "integer",
            "description": "Specifies the quantity of pages desired."
          }
        }
      },
      "ShippingLabelsFormat": {
        "enum": [
          "Avery",
          "Letter",
          "Zebra"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "SimpleTrackedShipment": {
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "accessGroups": {
            "uniqueItems": true,
            "type": "array",
            "description": "This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/AccessGroup"
            }
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "Master shipment id of the shipment. Will always be populated on the response.",
            "format": "uuid"
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Used to identify a shipment.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.",
            "format": "date-time"
          },
          "plan": {
            "$ref": "#/components/schemas/ShipmentPlan"
          },
          "shipmentShareLink": {
            "type": "string",
            "description": "Public link to view the shipment in the VOC."
          }
        },
        "description": "Simplified version of shipment tracking model used to initiate a shipment."
      },
      "SiteCodeListResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the operation",
            "example": "SUCCESS"
          },
          "sites": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "example": "SITE001"
                },
                "name": {
                  "type": "string",
                  "example": "Main Distribution Center"
                },
                "locationIdentifiers": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "example": [
                    "EXT001",
                    "EXT002"
                  ]
                }
              }
            },
            "description": "List of active site codes with their names and location identifiers",
            "example": [
              {
                "code": "SITE001",
                "name": "Main Distribution Center",
                "locationIdentifiers": [
                  "EXT001",
                  "EXT002"
                ]
              },
              {
                "code": "SITE002",
                "name": "Secondary Warehouse",
                "locationIdentifiers": [
                  "EXT003"
                ]
              },
              {
                "code": "SITE003",
                "name": "Regional Hub",
                "locationIdentifiers": []
              }
            ]
          }
        }
      },
      "SlotRequestSchema": {
        "type": "object",
        "required": [],
        "properties": {
          "appointmentWindow": {
            "type": "object",
            "required": [],
            "properties": {
              "start_date_time": {
                "type": "string",
                "format": "date-time",
                "description": "Start date and time for slot search (ISO 8601 format with timezone)",
                "example": "2024-01-15T00:00:00Z"
              },
              "end_date_time": {
                "type": "string",
                "format": "date-time",
                "description": "End date and time for slot search (ISO 8601 format with timezone)",
                "example": "2024-01-20T23:59:59Z"
              }
            }
          },
          "identifiers": {
            "type": "object",
            "required": [],
            "properties": {
              "shipmentReference": {
                "type": "string",
                "description": "Reference number for the shipment",
                "example": "SHIP123456"
              },
              "siteCode": {
                "type": "string",
                "description": "Code identifying the site",
                "example": "SITE001"
              },
              "stopSequenceNumber": {
                "type": "integer",
                "description": "Stop sequence number for multi-stop shipments",
                "example": 1
              }
            }
          }
        }
      },
      "SlotResult": {
        "type": "object",
        "properties": {
          "shipmentReference": {
            "type": "string",
            "description": "Reference number for the shipment",
            "example": "SHIP123456"
          },
          "siteCode": {
            "type": "string",
            "description": "Code identifying the site",
            "example": "SITE001"
          },
          "stopReferenceNumber": {
            "type": "integer",
            "description": "Stop reference number for multi-stop shipments",
            "example": 1
          },
          "slots": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SlotTime"
            }
          }
        }
      },
      "SlotsResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SlotResult"
            }
          },
          "status": {
            "type": "string",
            "description": "Status of the operation",
            "example": "SUCCESS"
          }
        }
      },
      "SlotTime": {
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "End date and time for the available slot (with timezone)",
            "example": "2024-01-15T12:00:00-05:00"
          },
          "startDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Start date and time for the available slot (with timezone)",
            "example": "2024-01-15T10:00:00-05:00"
          }
        }
      },
      "SortAndSegregateDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "pieces": {
            "type": "integer",
            "description": "Number of pieces in a shipment to be sorted/segregated."
          }
        }
      },
      "SortDirection": {
        "type": "string",
        "format": "enum",
        "enum": [
          "ASC",
          "DESC"
        ]
      },
      "SpecialOpeningHours": {
        "properties": {
          "hours": {
            "$ref": "#/components/schemas/OpeningHours"
          },
          "validFrom": {
            "description": "Date (inclusive) local to the stop to start applying the special hours. Formatted as yyyy-MM-dd",
            "format": "date",
            "type": "string"
          },
          "validThrough": {
            "description": "Date (exclusive) local to the stop to stop applying the special hours. Formatted as yyyy-MM-dd",
            "format": "date",
            "type": "string"
          }
        },
        "required": [],
        "title": "SpecialOpeningHours",
        "type": "object"
      },
      "SpecificationKind_bool_": {
        "required": [],
        "type": "object",
        "properties": {
          "value": {
            "type": "boolean"
          }
        }
      },
      "SpecificationKind_DeckHeight_": {
        "required": [],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/DeckHeight"
          }
        }
      },
      "SpecificationKind_ExcessiveLength_": {
        "required": [],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/ExcessiveLength"
          }
        }
      },
      "SpecificationKind_GuaranteedByHour_": {
        "required": [],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/GuaranteedByHour"
          }
        }
      },
      "SplitOffsetDateTime": {
        "description": "A date and optionally a time and time zone offset. This model is used where project44 cannot always guarantee a time or a time zone will be provided.",
        "properties": {
          "date": {
            "description": "The date portion of this this date time object. This field will always be  populated if this object is not null. (format: yyyy-MM-dd)",
            "format": "date",
            "type": "string"
          },
          "time": {
            "description": "The time portion of this date time object. This field may be null if it is unknown.  If this field is null, 'timeZoneOffset' will also be null. (format: HH:mm)",
            "example": "15:00:00",
            "type": "string"
          },
          "timeZoneOffset": {
            "description": "The time zone offset of this date time object. This field may be null  if it is unknown, in which case the date and time should be assumed local to the applicable location. UTC will be  indicated by an offset of '+0000'. (format: +HHmm or -HHmm)",
            "example": "-0500",
            "type": "string"
          }
        },
        "title": "SplitOffsetDateTime",
        "type": "object"
      },
      "SplitOffsetDateTimeWindow": {
        "description": "A date and time range, with optional times and time zone offsets.This model is used where project44 cannot always guarantee times or time zones will be provided.",
        "properties": {
          "endDateTime": {
            "$ref": "#/components/schemas/SplitOffsetDateTime"
          },
          "startDateTime": {
            "$ref": "#/components/schemas/SplitOffsetDateTime"
          }
        },
        "title": "SplitOffsetDateTimeWindow",
        "type": "object"
      },
      "StateProvinceCode": {
        "enum": [
          "AL",
          "AK",
          "AZ",
          "AR",
          "CA",
          "CO",
          "CT",
          "DC",
          "DE",
          "FL",
          "GA",
          "HI",
          "ID",
          "IL",
          "IN",
          "IA",
          "KS",
          "KY",
          "LA",
          "ME",
          "MD",
          "MA",
          "MI",
          "MN",
          "MS",
          "MO",
          "MT",
          "NE",
          "NV",
          "NH",
          "NJ",
          "NM",
          "NY",
          "NC",
          "ND",
          "OH",
          "OK",
          "OR",
          "PA",
          "PR",
          "RI",
          "SC",
          "SD",
          "TN",
          "TX",
          "UT",
          "VT",
          "VA",
          "WA",
          "WV",
          "WI",
          "WY",
          "AB",
          "BC",
          "MB",
          "NB",
          "NL",
          "NS",
          "NT",
          "NU",
          "ON",
          "PE",
          "QC",
          "SK",
          "YT",
          "CMX",
          "AGU",
          "BCN",
          "BCS",
          "CAM",
          "COA",
          "COL",
          "CHP",
          "CHH",
          "DUR",
          "GUA",
          "GRO",
          "HID",
          "JAL",
          "MEX",
          "MIC",
          "MOR",
          "NAY",
          "NLE",
          "OAX",
          "PUE",
          "QUE",
          "ROO",
          "SLP",
          "SIN",
          "SON",
          "TAB",
          "TAM",
          "TLA",
          "VER",
          "YUC",
          "ZAC"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "Stop": {
        "required": [],
        "type": "object",
        "properties": {
          "arrivalDate": {
            "type": "string",
            "description": "The date at which the carrier is scheduled to arrive at the stop.",
            "format": "date"
          },
          "arrivalAppointmentWindow": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeWindow"
              }
            ],
            "description": "Optional, any time-based window which the carrier is expected to arrive at the stop, zoned to the stop's location."
          },
          "accessorials": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/RefrigeratedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LiftgateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/TarpsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/StrapsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ChainsAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DeckHeightAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CraneAccessorial"
                },
                {
                  "$ref": "#/components/schemas/CallBeforeArrivalAccessorial"
                },
                {
                  "$ref": "#/components/schemas/DockRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/LockedGateAccessorial"
                },
                {
                  "$ref": "#/components/schemas/FirstComeFirstServedAccessorial"
                },
                {
                  "$ref": "#/components/schemas/AppointmentRequiredAccessorial"
                },
                {
                  "$ref": "#/components/schemas/WhiteGloveAccessorial"
                },
                {
                  "$ref": "#/components/schemas/HazmatAccessorial"
                },
                {
                  "$ref": "#/components/schemas/ExcessiveLengthAccessorial"
                },
                {
                  "$ref": "#/components/schemas/GuaranteedServiceLevelAccessorial"
                },
                {
                  "$ref": "#/components/schemas/OtherAccessorial"
                }
              ]
            },
            "description": "Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier."
          },
          "contacts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BookingContact"
            },
            "description": "Shipper-supplied individuals who may be contacted for correspondence related to shipment handling at the stop."
          },
          "id": {
            "type": "string",
            "description": "The id of this stop. Will always be populated on response.",
            "format": "uuid"
          },
          "location": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BookingLocation"
              }
            ],
            "description": "The location of the stop."
          },
          "loadingMethod": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LoadingMethod"
              }
            ],
            "description": "Loading method at this stop: LIVE (full load, driver waits) or DROP (power-only, drop trailer). Default is LIVE if not sent. A shipment can be live at origin and drop at destination. Used to filter rate contracts during contract matching.",
            "default": "LIVE"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StopType"
              }
            ],
            "description": "The type of stop."
          }
        }
      },
      "StopContact": {
        "type": "object",
        "properties": {
          "companyName": {
            "type": "string",
            "description": "Name of the Company with whom the Contact is associated."
          },
          "email": {
            "type": "string",
            "description": "The Contact's email address.",
            "format": "email"
          },
          "familyName": {
            "type": "string",
            "description": "The Contact's last or family name."
          },
          "givenName": {
            "type": "string",
            "description": "The Contact's first or given name."
          },
          "mobilePhoneNumber": {
            "type": "string",
            "description": "The Contact's mobile phone number."
          },
          "phoneNumber": {
            "type": "string",
            "description": "The Contact's work or other primary phone number."
          }
        }
      },
      "StopLocation": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "addressSpecificity": {
            "description": "The specificity of this address. Return only. This represents how sepcifically we were able to geocode the address, i.e., the most specific known entity we were able to match with it.",
            "enum": [
              "COUNTRY",
              "STATE",
              "COUNTY",
              "CITY",
              "DISTRICT",
              "POSTAL_CODE",
              "STREET",
              "INTERSECTION",
              "LANDMARK",
              "HOUSE_NUMBER"
            ],
            "type": "string"
          },
          "contacts": {
            "description": "A list of contact information for people associated with this location.",
            "items": {
              "$ref": "#/components/schemas/ContactReference"
            },
            "type": "array"
          },
          "coordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "geofence": {
            "$ref": "#/components/schemas/Geofence"
          },
          "id": {
            "description": "Stop location id. Should be null. Will be provided on return.",
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "description": "Name of the location. Nonblank value required.",
            "type": "string"
          },
          "openingHours": {
            "description": "Optional list of opening and closing hours of the stop location.",
            "items": {
              "$ref": "#/components/schemas/OpeningHours"
            },
            "type": "array"
          },
          "specialOpeningHours": {
            "description": "Optional list of special (i.e., holiday) opening and closing hours of the stop location.",
            "items": {
              "$ref": "#/components/schemas/SpecialOpeningHours"
            },
            "type": "array"
          },
          "suppliedId": {
            "description": "Customer-supplied identifier for this location.",
            "type": "string"
          },
          "version": {
            "description": "Version number of this location. Every time the location is edited this number is incremented.",
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [],
        "title": "StopLocation",
        "type": "object"
      },
      "StopLocationList": {
        "properties": {
          "locations": {
            "description": "Locations listed.",
            "items": {
              "$ref": "#/components/schemas/StopLocation"
            },
            "type": "array"
          },
          "offset": {
            "description": "Offset of the start of this list within the list of all matching locations.",
            "format": "int32",
            "type": "integer"
          },
          "pageSize": {
            "description": "Locations requested per page.",
            "format": "int32",
            "type": "integer"
          },
          "totalItems": {
            "description": "Total locations available.",
            "format": "int32",
            "type": "integer"
          }
        },
        "required": [],
        "title": "StopLocationList",
        "type": "object"
      },
      "StopReference": {
        "description": "Reference to a specific stop on a shipment.",
        "properties": {
          "stopId": {
            "description": "The unique identifier for a specific stop on a shipment.",
            "format": "uuid",
            "type": "string"
          }
        },
        "title": "StopReference",
        "type": "object"
      },
      "StopType": {
        "enum": [
          "PICKUP",
          "DELIVERY",
          "PICKUP_DELIVERY",
          "PORT_OF_LOADING",
          "PORT_OF_DISCHARGE",
          "TRANSSHIPMENT_PORT"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "StopTypeCriterion": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Only the EQUALS and NOT_EQUALS operators are supported for this criterion.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "UNKNOWN",
                "ORIGIN",
                "DESTINATION",
                "TRANSFER",
                "OTHER",
                "PORT_OF_LOADING",
                "TRANSSHIPMENT_PORT",
                "PORT_OF_DISCHARGE",
                "PICKUP",
                "DELIVERY",
                "RETURN",
                "WAREHOUSE",
                "HUB",
                "AIRPORT",
                "ORIGIN_CFS",
                "DESTINATION_CFS"
              ]
            }
          }
        },
        "description": "Match shipments based on stop type.\n\nTop-level items are combined using an AND operator, but the values within each item are combined using an OR operator.\n\nExample: (stop.type EQUALS [A OR B OR C])\n\nExample: (stop.type NOT_EQUALS A) AND (stop.type NOT_EQUALS B)"
      },
      "StrapsAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "STRAPS"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuantityKind"
              }
            ],
            "description": "Count and size of straps."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which delineates the expected size and number of straps used in shipping."
      },
      "TarpsAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "TARPS"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuantityKind"
              }
            ],
            "description": "Count and size of tarps."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which delineates the expected size and number of tarps used in shipping."
      },
      "TemperatureSensorDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "productCategoryBreachDetails": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductCategoryBreachDetails"
            }
          }
        }
      },
      "TempRangeKind": {
        "required": [],
        "type": "object",
        "properties": {
          "min": {
            "type": "number",
            "description": "Minimum range value."
          },
          "max": {
            "type": "number",
            "description": "Maximum range value."
          },
          "unit": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TempUnit"
              }
            ],
            "description": "Temperature unit."
          }
        },
        "additionalProperties": false
      },
      "TempUnit": {
        "enum": [
          "CELSIUS",
          "FAHRENHEIT"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "TerminatingCapacity": {
        "properties": {
          "carrierContact": {
            "$ref": "#/components/schemas/Contact"
          },
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "carrierIdentifiers": {
            "description": "List of carrier identifiers. Identifier type must be 'SCAC', 'DOT_NUMBER', or 'MC_NUMBER'.",
            "items": {
              "$ref": "#/components/schemas/CapacityProviderIdentifier"
            },
            "type": "array"
          },
          "distance": {
            "description": "Distance from the given location.",
            "format": "double",
            "type": "number"
          },
          "distanceUnit": {
            "description": "Distance unit. Must be KM or MI.",
            "enum": [
              "FT",
              "M",
              "MI",
              "KM"
            ],
            "type": "string"
          },
          "equipmentIdentifiers": {
            "description": "Equipment identifiers associated with the vehicle.",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "estimatedArrivalDateTime": {
            "description": "Estimated time when the vehicle will arrive at a terminating location.",
            "type": "string"
          },
          "truckType": {
            "description": "The type of truck.",
            "enum": [
              "AUTO_CARRIER",
              "B_TRAIN",
              "CONESTOGA",
              "CONTAINER",
              "CONTAINER_INSULATED",
              "CONTAINER_REFRIGERATED",
              "CONVEYOR",
              "DOUBLE_DROP",
              "DROP_DECK_LANDOLL",
              "DUMP_TRAILER",
              "FLAT_BED",
              "FLATBED_AIR_RIDE",
              "FLATBED_CONESTOGA",
              "FLATBED_DOUBLE",
              "FLATBED_HAZMAT",
              "FLATBED_HOTSHOT",
              "FLATBED_MAXI",
              "FLATBED_STEP_DECK",
              "FLATBED_OVERDOMENSION",
              "FLATBED_OVERDIMENSION",
              "FLATBED_CHAINS",
              "FLATBED_SIDES",
              "FLATBED_TARPS",
              "FLATBED_TEAM",
              "FLATBED_VAN_REEFER",
              "HOPPER_BOTTOM",
              "INSULATED_VAN_REEFER",
              "LOWBOY",
              "LOWBOY_REM_GOOSENECK",
              "LOWBOY_OVERDIMENSION",
              "MOVING_VAN",
              "PNEUMATIC",
              "POWER_ONLY",
              "REEFER",
              "REEFER_AIR_RIDE",
              "REEFER_DOUBLE",
              "REEFER_HAZMAT",
              "REEFER_INTERMODAL",
              "REEFER_LOGISTICS",
              "REEFER_VENTED_VAN",
              "REEFER_PALLET_EXCHANGE",
              "REEFER_TEAM",
              "REMOVABLE_GOOSENECK",
              "STEP_DECK",
              "STEP_DECK_REM_GOOSENECK",
              "STEP_DECK_CONESTOGA",
              "STRAIGHT_BOX_TRUCK",
              "STRETCH_TRAILER",
              "TANKER_ALUMINUM",
              "TANKER_INTERMODAL",
              "TANKER_STEEL",
              "TRUCK_AND_TRAILER",
              "DRY_VAN",
              "VAN",
              "VAN_AIR_RIDE",
              "VAN_BLANKET_WRAP",
              "VAN_CONESTOGA",
              "VAN_DOUBLE",
              "VAN_HAZMAT",
              "VAN_HOTSHOT",
              "VAN_INSULATED",
              "VAN_INTERMODAL",
              "VAN_LIFT_GATE",
              "VAN_LOGISTICS",
              "VAN_OPEN_TOP",
              "VAN_FLATBED",
              "VAN_FLATBED_TARPS",
              "VAN_FLATBET",
              "VAN_FLATBET_TARPS",
              "VAN_REEFER",
              "VAN_PALLET_EXCHANGE",
              "VAN_ROLLER_BED",
              "VAN_TRIPLE",
              "VAN_VENTED",
              "VAN_CURTAINS",
              "VAN_TEAM"
            ],
            "type": "string"
          }
        },
        "title": "TerminatingCapacity",
        "type": "object"
      },
      "TimeCriticalDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "date": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateWindow"
              }
            ],
            "description": "Date and time window for the requested Time Critical Service."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeCriticalDetailsType"
              }
            ],
            "description": "Type of delivery required for the requested Time Critical Service.Required when accessorial codes list includes TCS code."
          }
        }
      },
      "TimeCriticalDetailsType": {
        "enum": [
          "Deliver On Date",
          "Deliver On or After Date",
          "Deliver By Date",
          "Delivery Window"
        ],
        "type": "string",
        "description": "Description when Freight should be delivered"
      },
      "TimeDuration": {
        "required": [],
        "type": "object",
        "properties": {
          "amount": {
            "minimum": 0,
            "type": "integer",
            "description": "The amount of time for a duration.",
            "format": "int64"
          },
          "unit": {
            "$ref": "#/components/schemas/TimeUnit"
          }
        },
        "description": "The threshold to check against. Required unless operator is EXISTS or NOT_EXISTS. The unit UNKNOWN is not supported."
      },
      "TimeDurationCriterion": {
        "type": "object",
        "properties": {
          "operator": {
            "type": "string",
            "description": "Defines how the target field must compare to the threshold in order to be considered a match. Defaults to EQUALS if not provided.",
            "enum": [
              "MORE_THAN",
              "MORE_THAN_OR_EQUALS",
              "LESS_THAN",
              "LESS_THAN_OR_EQUALS",
              "EQUALS",
              "NOT_EQUALS",
              "EXISTS",
              "NOT_EXISTS"
            ]
          },
          "value": {
            "$ref": "#/components/schemas/TimeDuration"
          }
        },
        "description": "A simple criterion that compares a numerical value against a static threshold."
      },
      "TimelinessCode": {
        "type": "string",
        "format": "enum",
        "enum": [
          "UNKNOWN",
          "EARLY",
          "ON_TIME",
          "LATE"
        ]
      },
      "TimeUnit": {
        "type": "string",
        "description": "The unit of time measurement for a duration.",
        "format": "enum",
        "enum": [
          "UNKNOWN",
          "MILLISECONDS",
          "SECONDS",
          "MINUTES",
          "HOURS",
          "DAYS",
          "WEEKS",
          "MONTHS",
          "YEARS"
        ]
      },
      "TimeWindow": {
        "required": [],
        "type": "object",
        "properties": {
          "endTime": {
            "type": "string",
            "description": "End time of this window in ISO format. An end time which occurs before the start time indicates that it should occur on the next day.",
            "format": "time"
          },
          "startTime": {
            "type": "string",
            "description": "Start time of this window in ISO format.",
            "format": "time"
          }
        },
        "description": "A time range."
      },
      "Timing": {
        "properties": {
          "actual": {
            "$ref": "#/components/schemas/TimingActual"
          },
          "estimate": {
            "$ref": "#/components/schemas/TimingEstimate"
          },
          "scheduled": {
            "$ref": "#/components/schemas/TimingScheduled"
          }
        },
        "title": "Timing",
        "type": "object"
      },
      "TimingActual": {
        "properties": {
          "dateTime": {
            "description": "The actual date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "timelinessCode": {
            "description": "The actual arrival or departure status, as calculated.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          }
        },
        "title": "TimingActual",
        "type": "object"
      },
      "TimingEstimate": {
        "properties": {
          "estimatedTimeWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "lastCalculatedDateTime": {
            "description": "When this estimate was last computed. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "timelinessCode": {
            "description": "The estimated arrival or departure status.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          }
        },
        "title": "TimingEstimate",
        "type": "object"
      },
      "TimingScheduled": {
        "properties": {
          "dateTime": {
            "description": "The scheduled date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "timelinessCode": {
            "description": "The scheduled arrival or departure status, as calculated.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          }
        },
        "title": "TimingScheduled",
        "type": "object"
      },
      "TrackedShipment": {
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "accessGroups": {
            "uniqueItems": true,
            "type": "array",
            "description": "This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/AccessGroup"
            }
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "Master shipment id of the shipment. Will always be populated on the response.",
            "format": "uuid"
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Used to identify a shipment.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.",
            "format": "date-time"
          },
          "plan": {
            "$ref": "#/components/schemas/ShipmentPlan"
          },
          "routeInfo": {
            "$ref": "#/components/schemas/ShipmentRouteInfo"
          },
          "relatedShipments": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "List of related shipments of the parent shipment. This is optional.",
            "xml": {
              "name": "sub_shipments",
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/SimpleTrackedShipment"
            }
          },
          "shipmentShareLink": {
            "type": "string",
            "description": "Public link to view the shipment in the VOC."
          }
        },
        "description": "Shipment tracking model used to initiate a shipment."
      },
      "TrackedShipmentContent": {
        "type": "object",
        "properties": {
          "minTemperatureThreshold": {
            "type": "number",
            "format": "float"
          },
          "maxTemperatureThreshold": {
            "type": "number",
            "format": "float"
          },
          "productCategory": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "FROZEN_FOOD",
              "REFRIGERATED_FOOD",
              "HOT_PREPARED_FOODS",
              "FRESH_MEAT_AND_POULTRY",
              "FROZEN_MEAT_AND_SEAFOOD",
              "FRESH_SEAFOOD",
              "DAIRY_PRODUCTS",
              "FROZEN_DAIRY",
              "FRESH_PRODUCE",
              "TROPICAL_FRUITS_AND_VEGETABLES",
              "ROOT_VEGETABLES",
              "WATERMELONS_AND_CUCUMBERS",
              "VACCINES_AND_BIOLOGICS",
              "ULTRA_COLD_STORAGE_VACCINES",
              "BLOOD_AND_PLASMA_PRODUCTS",
              "STERILE_INJECTABLE_MEDICATIONS",
              "DIAGNOSTIC_KITS_AND_MEDICAL_TESTING_EQUIPMENT",
              "LITHIUM_ION_BATTERIES",
              "SEMICONDUCTORS_AND_MICROCHIPS",
              "RUBBER_AND_POLYMER_BASED_AUTO_PARTS",
              "FRESH_CUT_FLOWERS",
              "TROPICAL_FLOWERS"
            ]
          },
          "temperatureSetPoint": {
            "type": "number",
            "format": "float"
          }
        },
        "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments."
      },
      "TrackedShipmentCost": {
        "required": [],
        "type": "object",
        "properties": {
          "identifiers": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "A list of identifiers that specify the asset to which this cost or fee pertains.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "type": {
            "type": "string",
            "description": "The type of cost or fee that occurred. Will always be populated.",
            "enum": [
              "UNKNOWN",
              "EXPORT_DEMURRAGE",
              "EXPORT_DETENTION",
              "IMPORT_DEMURRAGE",
              "IMPORT_DETENTION"
            ]
          },
          "totalCost": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "tier": {
            "type": "string",
            "description": "The current tier that is applied to calculate the costs.",
            "enum": [
              "UNKNOWN",
              "FREE_PERIOD",
              "FIRST_PERIOD",
              "SECOND_PERIOD",
              "THEREAFTER_PERIOD"
            ]
          }
        },
        "description": "A representation of a cost or fee incurred by a shipment or some asset pertaining to the shipment."
      },
      "TrackedShipmentDateTime": {
        "required": [],
        "type": "object",
        "properties": {
          "dateTime": {
            "minLength": 1,
            "type": "string",
            "description": "The time that this event occurred or will occur. If accompanied by endDateTime, this value denotes the start time of the resulting window.",
            "format": "date-time"
          },
          "endDateTime": {
            "type": "string",
            "description": "The end time of the window in which the event occurred or will occur.",
            "format": "date-time"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "Denotes when the provided dateTime was last modified.",
            "format": "date-time"
          },
          "source": {
            "type": "string",
            "description": "The source of the provided dateTime.<br><br>UNKNOWN - The source of the provided dateTime is unknown.<br>CARRIER -The dateTime is provided by CARRIER.<br>BROKER - The dateTime is provided by BROKER.<br>FFW - The dateTime is provided by FFW.<br>USER - The dateTime is provided by USER. Can only provide this value in POST/PUT. <br>CONTRACT - Contractually defined dateTime. <br>GEOFENCE - The dateTime is provided by GEOFENCE logic.<br>FACILITY - The dateTime is provided by a facility (e.g. terminal, airport, container depot, cross-dock station).<br>P44 - The dateTime is calculated by other P44 services.",
            "enum": [
              "UNKNOWN",
              "CARRIER",
              "BROKER",
              "FFW",
              "USER",
              "CONTRACT",
              "GEOFENCE",
              "FACILITY",
              "P44",
              "NVOCC"
            ]
          },
          "sourceIdentifiers": {
            "type": "array",
            "description": "An optional list of standardized 3rd party identifiers which provide more detail about the source of this dateTime. Can indicate a specific device, vehicle, carrier, or other freight entity.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "selected": {
            "type": "boolean",
            "description": "Denotes whether this dateTime is the one used as the top level dateTime of the event."
          },
          "sequence": {
            "type": "integer",
            "description": "A number that indicates the order in which dateTimes of the same type and source were received.",
            "format": "int32"
          },
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "The type of the dateTime provided.<br><br>PLANNED - Denotes that a dateTime is planned or scheduled to occur.<br>ACTUAL - Denotes that a dateTime actually occurred.<br>ESTIMATE - Denotes that a dateTime is a calculated estimate.",
            "enum": [
              "UNKNOWN",
              "PLANNED",
              "ACTUAL",
              "ESTIMATE"
            ]
          }
        },
        "description": "A dateTime for the event provided by a certain source."
      },
      "TrackedShipmentEvent": {
        "type": "object",
        "properties": {
          "dateTime": {
            "type": "string",
            "description": "The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.",
            "format": "date-time"
          },
          "description": {
            "type": "string",
            "description": "A human readable description of this event. Optional response field."
          },
          "dateTimes": {
            "type": "array",
            "description": "A list of times retrieved from different sources.",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentDateTime"
            }
          },
          "details": {
            "$ref": "#/components/schemas/TrackedShipmentEventDetails"
          },
          "estimateDateTime": {
            "type": "string",
            "description": "The estimated time that this event is likely to occur. Only populated if event has not occurred yet.",
            "format": "date-time"
          },
          "estimateLastCalculatedDateTime": {
            "type": "string",
            "description": "The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.",
            "format": "date-time"
          },
          "id": {
            "type": "string",
            "description": "The unique identifier of the event. Might not be provided for shipments created in 2024 and earlier.",
            "format": "uuid"
          },
          "plannedDateTime": {
            "type": "string",
            "description": "The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.",
            "format": "date-time"
          },
          "plannedEndDateTime": {
            "type": "string",
            "description": "The end of the planned window of time for the event.",
            "format": "date-time"
          },
          "receivedDateTime": {
            "type": "string",
            "description": "The time when project44 received or calculated this event. Will only be populated for events that have already happened.",
            "format": "date-time"
          },
          "routeSegmentId": {
            "type": "string",
            "description": "If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.",
            "format": "uuid"
          },
          "stopId": {
            "type": "string",
            "description": "If relevant, this will be populated with the id of the stop to which this event relates.",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "description": "The type of event that occurred. Will always be populated.",
            "enum": [
              "UNKNOWN",
              "TRACKING_INITIATE",
              "TRACKING_START",
              "ARRIVAL_AT_STOP",
              "DEPARTURE_FROM_STOP",
              "LOAD_ONTO_VEHICLE",
              "UNLOAD_FROM_VEHICLE",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_END_BY_USER",
              "TRACKING_COMPLETE",
              "GATE_IN",
              "GATE_OUT",
              "FLIGHT_BOOKING",
              "MANIFEST",
              "RECEIVE_FROM_SHIPPER",
              "CONSIGNEE_NOTIFY",
              "DELIVERY",
              "WARNING",
              "EXCEPTION",
              "TRACKING_STOP",
              "EXCEPTION_LATE_DEPARTURE",
              "EXCEPTION_MISSED_CONNECTION",
              "GATE_IN_FULL",
              "GATE_IN_EMPTY",
              "GATE_OUT_EMPTY",
              "GATE_OUT_FULL",
              "LOAD",
              "DISCHARGE",
              "EXCEPTION_DELAYED",
              "EXCEPTION_DELIVERY_MISSED",
              "EXCEPTION_HELD",
              "EXCEPTION_PICKUP_MISSED",
              "AVAILABLE",
              "ENTERED_GEOFENCE",
              "EXITED_GEOFENCE",
              "INFO",
              "OUT_FOR_DELIVERY",
              "PICKED_UP",
              "RETURN_TO_SENDER",
              "TRACKING_FAILED",
              "UNAUTHORIZED",
              "PICKUP_MISSED",
              "SURVEY",
              "HELD",
              "CLEAN_TRUCK_FEE_CLEARANCE",
              "CLEAN_TRUCK_FEE_HOLD",
              "OTHER_HOLD",
              "OTHER_HOLD_CLEARANCE",
              "TERMINAL_CLEARANCE",
              "TERMINAL_HOLD",
              "TRAFFIC_MITIGATION_FEE_CLEARANCE",
              "TRAFFIC_MITIGATION_FEE_HOLD",
              "RELEASE",
              "DELAYED",
              "DELIVERY_MISSED",
              "ENTERED_INNER_GEOFENCE",
              "EXITED_INNER_GEOFENCE",
              "ENTERED_OUTER_GEOFENCE",
              "EXITED_OUTER_GEOFENCE",
              "ENTERED_FINAL_GEOFENCE",
              "EXITED_FINAL_GEOFENCE",
              "IDLE",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "DISPATCH",
              "CUSTOMS_HOLD",
              "CUSTOMS_CLEARANCE",
              "CUSTOMS_DOCS_FILING",
              "CUSTOMS_TRANSIT_DOCS_ISSUED",
              "CUSTOMS_TRANSIT_DOCS_CLOSED",
              "CARRIER_HOLD",
              "RECEIVE_FROM_CARRIER",
              "ISSUE_FREIGHT_BILL",
              "FREIGHT_ON_HAND",
              "READY_FOR_CARRIAGE",
              "LAST_FREE_DAY",
              "MISSING_CARRIER",
              "STUFF",
              "STRIP",
              "SEAL_INSPECTION",
              "SEAL_REMOVAL",
              "SEAL_RESEAL",
              "HANDOVER",
              "DOCUMENT_ADD",
              "DOCUMENT_REMOVE",
              "REMOVE_FROM_BOOKING",
              "COST_UPDATE",
              "SHARING_STOPPED",
              "ROLLED_OVER",
              "BAD_ORDER",
              "BAD_ORDER_RELEASE"
            ]
          }
        },
        "description": "An event is something that occurs at a point in time for a shipment."
      },
      "TrackedShipmentEventDetails": {
        "type": "object",
        "properties": {
          "documentDetails": {
            "$ref": "#/components/schemas/DocumentEventDetails"
          },
          "mobileTracking": {
            "$ref": "#/components/schemas/MobileTrackingEventDetails"
          },
          "ocean": {
            "$ref": "#/components/schemas/OceanEventDetails"
          },
          "qualityControl": {
            "$ref": "#/components/schemas/QualityControlEventDetails"
          },
          "rolloverDetails": {
            "$ref": "#/components/schemas/RolloverDetails"
          }
        },
        "description": "Optional extended details of an event."
      },
      "TrackedShipmentHistory": {
        "type": "object",
        "properties": {
          "costs": {
            "type": "array",
            "description": "All costs incurred for this shipment and the assets contained within.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentCost"
            }
          },
          "contents": {
            "type": "array",
            "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/ShipmentContent"
            }
          },
          "events": {
            "type": "array",
            "description": "All events that occurred for this shipment. Will always be in ascending order by the date the event occurred.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentEvent"
            }
          },
          "exceptions": {
            "type": "array",
            "description": "${ShipmentEventHistory.apiModel.exceptions.value}",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/ShipmentException"
            }
          },
          "positions": {
            "type": "array",
            "description": "Locations where this shipment has been recorded. Data may be down-sampled. Will always be in ascending order by the date that the shipment was at that position.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentPosition"
            }
          },
          "shipment": {
            "$ref": "#/components/schemas/TrackedShipment"
          },
          "states": {
            "type": "array",
            "description": "All states that the shipment was or currently is in. Order is not guaranteed.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentState"
            }
          },
          "sharingContext": {
            "$ref": "#/components/schemas/SharingContext"
          },
          "sensorContext": {
            "$ref": "#/components/schemas/SensorContext"
          }
        },
        "description": "The history of everything that has occurred for the shipment during tracking."
      },
      "TrackedShipmentPosition": {
        "type": "object",
        "properties": {
          "dateTime": {
            "type": "string",
            "description": "The timestamp denoting when the shipment was detected at the given coordinates.",
            "format": "date-time"
          },
          "latitude": {
            "maximum": 90,
            "minimum": -90,
            "type": "number",
            "description": "The geographic latitude, using the WGS84 coordinate system.",
            "format": "float"
          },
          "longitude": {
            "maximum": 180,
            "minimum": -180,
            "type": "number",
            "description": "The geographic longitude, using the WGS84 coordinate system.",
            "format": "float"
          },
          "receivedDateTime": {
            "type": "string",
            "description": "The date and time that project44 received this position data.",
            "format": "date-time"
          },
          "routeSegmentId": {
            "type": "string",
            "description": "The route segment on which the shipment was traveling when it was at this position.",
            "format": "uuid"
          }
        },
        "description": "The geographic coordinates where a shipment was located at a given point in time. This data may have been down-sampled."
      },
      "TrackedShipmentRouteSegment": {
        "description": "Describes how a shipment moved between 2 stops.",
        "properties": {
          "emissions": {
            "$ref": "#/components/schemas/EmissionData"
          },
          "fromStopId": {
            "description": "The starting stop of this route segment. Will always be populated on response.",
            "format": "uuid",
            "type": "string"
          },
          "id": {
            "description": "The id of this route segment. Will always be populated on response.",
            "format": "uuid",
            "type": "string"
          },
          "identifiers": {
            "description": "Identifiers that are not part of the overall shipment but are relevant to this route segment.",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            },
            "type": "array"
          },
          "toStopId": {
            "description": "The ending stop of this route segment. Will always be populated on response.",
            "format": "uuid",
            "type": "string"
          },
          "transportationMode": {
            "description": "The mode of transportation on which the shipment was traveling. Will always be populated on response.",
            "enum": [
              "AIR",
              "OCEAN",
              "RAIL",
              "UNKNOWN",
              "TRUCKLOAD",
              "PARCEL",
              "LTL",
              "BARGE"
            ],
            "type": "string"
          }
        },
        "title": "TrackedShipmentRouteSegment",
        "type": "object"
      },
      "TrackedShipmentState": {
        "type": "object",
        "properties": {
          "endDateTime": {
            "type": "string",
            "description": "The time that this state ended. May not be populated if the shipment is still in this state.",
            "format": "date-time"
          },
          "routeSegmentId": {
            "type": "string",
            "description": "If relevant, this will be populated with the id of a route segment on which this state occurred.",
            "format": "uuid"
          },
          "startDateTime": {
            "type": "string",
            "description": "The time that this state began. May not be populated if the shipment is not yet in this state or if we do not have data for when this state began.",
            "format": "date-time"
          },
          "stopId": {
            "type": "string",
            "description": "If relevant, this will be populated with the id of the stop to which this state relates",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "description": "The specific type of state that the shipment was in. Will always be populated.",
            "enum": [
              "UNKNOWN",
              "AT_STOP",
              "IN_TRANSIT_AIRCRAFT",
              "IN_TRANSIT_VESSEL",
              "IN_TRANSIT_RAIL",
              "CUSTOMS_HOLD",
              "IN_TRANSIT",
              "COMPLETED",
              "SCHEDULED",
              "IDLE",
              "ACTION_REQUIRED"
            ]
          }
        },
        "description": "A state is some condition that the shipment was in between a start and end time. States are always started and ended by an event."
      },
      "TrackedShipmentStop": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id of this stop. Will always be populated on response.",
            "format": "uuid"
          },
          "location": {
            "$ref": "#/components/schemas/TrackedShipmentStopLocation"
          },
          "type": {
            "type": "string",
            "description": "The type of stop.",
            "enum": [
              "UNKNOWN",
              "ORIGIN",
              "DESTINATION",
              "TRANSFER",
              "OTHER",
              "PORT_OF_LOADING",
              "TRANSSHIPMENT_PORT",
              "PORT_OF_DISCHARGE",
              "PICKUP",
              "DELIVERY",
              "RETURN",
              "WAREHOUSE",
              "HUB",
              "AIRPORT",
              "ORIGIN_CFS",
              "DESTINATION_CFS"
            ]
          }
        },
        "description": "Information about a stop."
      },
      "TrackedShipmentStopLocation": {
        "required": [],
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "coordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "id": {
            "type": "string",
            "description": "The id of the location.",
            "format": "uuid"
          },
          "identifiers": {
            "minItems": 1,
            "type": "array",
            "description": "List of standard identifiers associated with this location.",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentStopLocationIdentifier"
            }
          },
          "masterLocationId": {
            "type": "string",
            "description": "The master location id of the location.",
            "format": "uuid"
          },
          "name": {
            "minLength": 1,
            "type": "string",
            "description": "The name of the location."
          },
          "timeZone": {
            "type": "string",
            "description": "TZ database identifier of the time zone at the stop (https://www.iana.org/time-zones)"
          }
        },
        "description": "The location of the stop.",
        "xml": {
          "name": "TrackedShipmentStopLocation"
        }
      },
      "TrackedShipmentStopLocationIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of identifier and authority who assigns these identifiers.",
            "enum": [
              "AIRPORT_IATA",
              "AIRPORT_ICAO",
              "EXTERNAL",
              "LOCODE",
              "NAME",
              "PORT_UN_LOCODE",
              "FACILITY_ID",
              "RAIL_SPLC",
              "RAIL_UIC",
              "RAIL_EU_PLC",
              "UNKNOWN"
            ]
          },
          "value": {
            "minLength": 1,
            "type": "string",
            "description": "The value of the identifier."
          }
        },
        "description": "Standard identifier used to identify a location."
      },
      "TrackedShipmentWithEvents": {
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "An optional user-defined set of custom attributes to associate with this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "accessGroups": {
            "uniqueItems": true,
            "type": "array",
            "description": "This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/AccessGroup"
            }
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.",
            "format": "date-time"
          },
          "costs": {
            "maxItems": 25,
            "minItems": 0,
            "type": "array",
            "description": "All costs incurred for this shipment and the assets contained within.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentCost"
            }
          },
          "contents": {
            "type": "array",
            "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentContent"
            }
          },
          "events": {
            "type": "array",
            "description": "All events that occurred for this shipment.",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentEvent"
            }
          },
          "id": {
            "type": "string",
            "description": "Master shipment id of the shipment. Will always be populated on the response.",
            "format": "uuid"
          },
          "identifiers": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "Used to identify a shipment.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>",
            "xml": {
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.",
            "format": "date-time"
          },
          "plan": {
            "$ref": "#/components/schemas/ShipmentPlan"
          },
          "routeInfo": {
            "$ref": "#/components/schemas/ShipmentRouteInfo"
          },
          "relatedShipments": {
            "maxItems": 250,
            "minItems": 0,
            "type": "array",
            "description": "List of related shipments of the parent shipment. This is optional.",
            "xml": {
              "name": "sub_shipments",
              "wrapped": true
            },
            "items": {
              "$ref": "#/components/schemas/SimpleTrackedShipment"
            }
          },
          "shipmentShareLink": {
            "type": "string",
            "description": "Public link to view the shipment in the VOC."
          }
        },
        "description": "Shipment tracking model used to initiate a shipment."
      },
      "TrackingStatusEvent": {
        "required": [],
        "type": "object",
        "properties": {
          "dateTime": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "enum": [
              "TRACKING_INITIATE",
              "TRACKING_START",
              "TRACKING_END_BY_USER",
              "TRACKING_END_DUE_TO_TIMEOUT",
              "TRACKING_FAILED",
              "TRACKING_COMPLETE",
              "TRACKING_STOP",
              "DRIVER_DENY_TRACKING",
              "UNKNOWN_EQUIPMENT_IDENTIFIER",
              "MISSING_EQUIPMENT_IDENTIFIER",
              "REMOVE_FROM_BOOKING",
              "SHARING_STOPPED",
              "UNKNOWN"
            ]
          }
        }
      },
      "TrailerType": {
        "enum": [
          "FLATBED",
          "REFRIGERATED",
          "DRY_VAN",
          "VAN_CURTAINS",
          "MEGA",
          "TANKER",
          "LOWBOY",
          "JUMBO",
          "AUTO_CARRIER",
          "TRAILER",
          "VAN",
          "STRETCH_TRAILER",
          "CONTAINER"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "TransitTimeQuote": {
        "description": "A transit time quote response.",
        "properties": {
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "carrierCode": {
            "description": "SCAC of the carrier to which this rate quote applies. This is used to differentiate among rate quotes from capacity providers that support multiple SCACs.",
            "type": "string"
          },
          "deliveryDateTime": {
            "description": "The delivery date and time, if provided. (format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "errorMessages": {
            "description": "System messages and messages from the capacity provider with severity 'ERROR'. No messages with severity 'INFO' or 'WARNING' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "transitDays": {
            "description": "The number of service days to deliver the shipment being quoted after it is picked up.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "TransitTimeQuote",
        "type": "object"
      },
      "TransitTimeQuoteApiConfiguration": {
        "description": "Contains fields used to configure the transit time quote API.",
        "properties": {
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          },
          "timeout": {
            "description": "Number of seconds to wait for a capacity provider to return a transit time quote. (default: '10')",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "TransitTimeQuoteApiConfiguration",
        "type": "object"
      },
      "TransitTimeQuoteCollection": {
        "description": "Container for a list of transit time quotes returned by a transit time quote query.",
        "properties": {
          "transitTimeQuotes": {
            "description": "List of transit time quotes from all capacity providers requested.",
            "items": {
              "$ref": "#/components/schemas/TransitTimeQuote"
            },
            "type": "array"
          }
        },
        "title": "TransitTimeQuoteCollection",
        "type": "object"
      },
      "TransitTimeQuoteQuery": {
        "description": "A transit time quote request.",
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/TransitTimeQuoteApiConfiguration"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "destinationAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "originAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "pickupDate": {
            "description": "The pickup date in the timezone of the origin location of the shipment being quoted. (default: current date; format: yyyy-MM-dd)",
            "format": "date",
            "type": "string"
          }
        },
        "title": "TransitTimeQuoteQuery",
        "type": "object"
      },
      "TransportationMode": {
        "enum": [
          "OCEAN",
          "AIR",
          "RAIL",
          "TRUCKLOAD",
          "LTL",
          "VOLUME_LTL"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "TruckDetails": {
        "required": [],
        "type": "object",
        "properties": {
          "flatbedType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FlatbedType"
              }
            ],
            "description": "The sub-equipment type of flatbed. Only applicable, and required, with a FLATBED trailer type."
          },
          "loadPreference": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TruckLoadPreferenceType"
              }
            ],
            "description": "The preferred load occupancy of the truck."
          },
          "trailerType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TrailerType"
              }
            ],
            "description": "The equipment type of the trailer."
          },
          "trailerLength": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Length"
              }
            ],
            "description": "Total requested trailer length in feet or meters; must not exceed 53 Feet or 17 meters."
          },
          "trailerVolume": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volume"
              }
            ],
            "description": "Total requested Trailer volume."
          },
          "trailerDetails": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RefrigeratedTrailerDetails"
              }
            ],
            "description": "Optional, trailer details when trailer type is REFRIGERATED."
          }
        }
      },
      "TruckloadAdditionalAppointmentWindow": {
        "description": "A user defined appointment window to be used in lists.",
        "properties": {
          "appointmentStatus": {
            "description": "This is the state of the appointment as determined by the source appointment management system.  This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment. ",
            "enum": [
              "PENDING",
              "REJECTED",
              "BOOKED",
              "CANCELLED",
              "COMPLETED",
              "PENDING_CARRIER",
              "PENDING_INTERNAL",
              "NONE_AVAILABLE"
            ],
            "type": "string"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "identifiers": {
            "description": "A list of identifiers of the additional appointment windows to a shipment.",
            "items": {
              "$ref": "#/components/schemas/AdditionalAppointmentWindowIdentifier"
            },
            "type": "array"
          },
          "type": {
            "description": "The type of appointment window.",
            "enum": [
              "STRATEGIC",
              "SLOT_BOOKING_PICKUP",
              "SLOT_BOOKING_DELIVERY",
              "SLOT_BOOKING_PICKUP_DELIVERY"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadAdditionalAppointmentWindow",
        "type": "object"
      },
      "TruckloadAdditionalAppointmentWindowStatus": {
        "description": "Calculated status for an additional appointment window of a given type",
        "properties": {
          "scanDateTime": {
            "description": "The scan date and time used in the calculation of this additional appointment window status.( format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "statusCode": {
            "description": "The status of the additional appointment window",
            "enum": [
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "windowType": {
            "description": "The type of additional appointment window to which this additional appointment window status belongs",
            "enum": [
              "STRATEGIC",
              "SLOT_BOOKING_PICKUP",
              "SLOT_BOOKING_DELIVERY",
              "SLOT_BOOKING_PICKUP_DELIVERY"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadAdditionalAppointmentWindowStatus",
        "type": "object"
      },
      "TruckloadArrivalEstimate": {
        "properties": {
          "estimatedArrivalWindow": {
            "$ref": "#/components/schemas/OffsetDateTimeWindow"
          },
          "lastCalculatedDateTime": {
            "description": "When this eta was last computed. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          }
        },
        "title": "TruckloadArrivalEstimate",
        "type": "object"
      },
      "TruckloadAssetCollection": {
        "description": "List of matching asset identifiers",
        "properties": {
          "infoMessages": {
            "description": "List of messages associated with the results",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "TruckloadAssetCollection",
        "type": "object"
      },
      "TruckloadBookingResponseDetails": {
        "type": "object",
        "properties": {}
      },
      "TruckloadCapacityProviderPushShipmentStop": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "arrivalDateTime": {
            "format": "date-time",
            "type": "string"
          },
          "carrierSuppliedEta": {
            "type": "string"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "departureDateTime": {
            "format": "date-time",
            "type": "string"
          },
          "stopName": {
            "type": "string"
          },
          "stopNumber": {
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "TruckloadCapacityProviderPushShipmentStop",
        "type": "object"
      },
      "TruckloadCapacityProviderPushStatusUpdate": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerId": {
            "type": "string"
          },
          "equipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "eventStopNumber": {
            "format": "int32",
            "type": "integer"
          },
          "eventType": {
            "enum": [
              "DELIVERED",
              "CANCELLED",
              "DEPARTED",
              "ARRIVED",
              "DISPATCHED",
              "LOADING",
              "UNLOADING",
              "SCANNED_AT_STOP",
              "POSITION",
              "GATE_IN",
              "GATE_OUT",
              "ARRIVED_AT_TERMINAL",
              "DEPARTED_TERMINAL"
            ],
            "type": "string"
          },
          "hoursOfServiceRemaining": {
            "format": "int32",
            "type": "integer"
          },
          "latestTemperature": {
            "type": "number"
          },
          "latestTemperatureUnit": {
            "enum": [
              "F",
              "C"
            ],
            "type": "string"
          },
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          },
          "shipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "items": {
              "$ref": "#/components/schemas/TruckloadCapacityProviderPushShipmentStop"
            },
            "type": "array"
          },
          "utcTimestamp": {
            "format": "date-time",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderPushStatusUpdate",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderAcceptance": {
        "description": "An object that a capacity provider pushes to accept a Truckload Tender.",
        "properties": {
          "capacityProviderOfferIdentifier": {
            "description": "This field contains the identifier that should be used to select this capacity provider's offer for dispatching.",
            "type": "string"
          },
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "equipmentIdentifiers": {
            "description": "Carrier provided equipment identifiers that can be used to facilitate tracking.",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "offerExpirationDateTime": {
            "description": "The expiration date time of this capacity provider offer. A time zone offset must be provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "trackingShipmentIdentifiers": {
            "description": "Carrier provided shipment identifiers that can be used to facilitate tracking.",
            "items": {
              "$ref": "#/components/schemas/TruckloadTenderTrackingShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "TruckloadCapacityProviderTenderAcceptance",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderAcceptanceConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "tenderAcceptance": {
            "$ref": "#/components/schemas/TruckloadCapacityProviderTenderAcceptance"
          },
          "tenderIdentifier": {
            "description": "The capacity provider's identifier for the tender being accepted.",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderAcceptanceConfirmation",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderDecline": {
        "description": "An object that a capacity provider pushes in order to decline a specific Truckload Tender",
        "properties": {
          "capacityProviderDeclineIdentifier": {
            "description": "The capacity provider's identifier that references their decision to decline this tender.",
            "type": "string"
          },
          "declineReason": {
            "description": "A more detailed description of the capacity provider's reason for declining this tender.",
            "type": "string"
          },
          "declineReasonCode": {
            "description": "The capacity provider's reason for declining this tender.",
            "enum": [
              "DECLINED_CAPACITY_TYPE",
              "DECLINED_CAPACITY_UNAVAILABLE",
              "DECLINED_EQUIPMENT_TYPE",
              "DECLINED_EQUIPMENT_UNAVAILABLE",
              "DECLINED_LENGTH_OF_HAUL",
              "DECLINED_PERMITS",
              "DECLINED_WEIGHT"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderDecline",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderDeclineConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "tenderIdentifier": {
            "description": "The capacity provider's identifier for the tender being declined.",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderDeclineConfirmation",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderError": {
        "description": "An object that a capacity provider pushes in order to indicate a error with the Truckload Tender",
        "properties": {
          "capacityProviderErrorIdentifier": {
            "description": "The capacity provider's identifier that references their error for this tender.",
            "type": "string"
          },
          "errorReason": {
            "description": "A description of the capacity provider's reason for reporting an error with this tender.",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderError",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderErrorConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "tenderIdentifier": {
            "description": "The capacity provider's identifier for the tender having an error.",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderErrorConfirmation",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderRateQuote": {
        "description": "An object that represents a capacity provider's rate quote for a truckload tender.",
        "properties": {
          "capacityProviderOfferIdentifier": {
            "description": "This field contains the identifier that should be used to select this capacity provider's offer for dispatching.",
            "type": "string"
          },
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "currency": {
            "description": "The currency used to express the capacity provider's quoted price.",
            "enum": [
              "USD",
              "CAD",
              "MXN",
              "EUR"
            ],
            "type": "string"
          },
          "equipmentIdentifiers": {
            "description": "Carrier provided equipment identifiers that can be used to facilitate tracking.",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "offerExpirationDateTime": {
            "description": "The expiration date time of this capacity provider offer. A time zone offset must be provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).",
            "type": "string"
          },
          "rateQuoteDetail": {
            "$ref": "#/components/schemas/TruckloadRateQuoteDetail"
          },
          "trackingShipmentIdentifiers": {
            "description": "Carrier provided shipment identifiers that can be used to facilitate tracking.",
            "items": {
              "$ref": "#/components/schemas/TruckloadTenderTrackingShipmentIdentifier"
            },
            "type": "array"
          }
        },
        "title": "TruckloadCapacityProviderTenderRateQuote",
        "type": "object"
      },
      "TruckloadCapacityProviderTenderRateQuoteConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "rateQuote": {
            "$ref": "#/components/schemas/TruckloadCapacityProviderTenderRateQuote"
          },
          "tenderIdentifier": {
            "description": "The capacity provider's identifier for the tender being quoted.",
            "type": "string"
          }
        },
        "title": "TruckloadCapacityProviderTenderRateQuoteConfirmation",
        "type": "object"
      },
      "TruckloadEquipmentIdentifier": {
        "properties": {
          "shouldDelete": {
            "description": "Optional field indicating whether equipment identifier should be deleted.",
            "type": "boolean"
          },
          "type": {
            "description": "The type of the equipment identifier.",
            "enum": [
              "MOBILE_PHONE_NUMBER",
              "VEHICLE_ID",
              "LICENSE_PLATE",
              "SENSITECH_DEVICE_ID",
              "TIVE_DEVICE_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the equipment identifier. Cell phone numbers will be obfuscated in project44 responses for privacy reasons.",
            "type": "string"
          }
        },
        "title": "TruckloadEquipmentIdentifier",
        "type": "object"
      },
      "TruckloadEquipmentIdentifierAssignment": {
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerAccountNumber": {
            "type": "string"
          },
          "equipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "scheduledTruckChangeDateTime": {
            "type": "string"
          },
          "shipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentIdentifier"
            },
            "type": "array"
          },
          "shouldDelete": {
            "type": "boolean"
          }
        },
        "title": "TruckloadEquipmentIdentifierAssignment",
        "type": "object"
      },
      "TruckloadEquipmentIdentifierChange": {
        "description": "Contains a scheduled truck change.",
        "properties": {
          "timestamp": {
            "description": "The moment when the equipment identifier change should happen",
            "type": "string"
          },
          "type": {
            "description": "The type of the equipment identifier, should be one of MOBILE_PHONE_NUMBER, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE_ID, EMERSON_DEVICE_ID, TIVE_DEVICE_ID or CONTAINER_ID",
            "enum": [
              "MOBILE_PHONE_NUMBER",
              "VEHICLE_ID",
              "LICENSE_PLATE",
              "SENSITECH_DEVICE_ID",
              "EMERSON_DEVICE_ID",
              "TIVE_DEVICE_ID",
              "CONTAINER_ID"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the equipment identifier",
            "type": "string"
          }
        },
        "title": "TruckloadEquipmentIdentifierChange",
        "type": "object"
      },
      "TruckloadEquipmentValidationResult": {
        "description": "Result of an equipment validation check",
        "properties": {
          "exists": {
            "description": "True if asset exists in project44 platform. If equipment type is not MOBILE_PHONE_NUMBER and LICENSE_PLATE, capacity provider must be the owner of the equipment, otherwise false.",
            "type": "boolean"
          },
          "ownershipStatus": {
            "description": "${TruckloadEquipmentValidation.apiModel.ownershipStatus.value}",
            "enum": [
              "CONNECTED",
              "NOT_CONNECTED",
              "INDETERMINATE",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "valid": {
            "description": "True if the identifier may be used to initiate tracking, otherwise false.",
            "type": "boolean"
          }
        },
        "title": "TruckloadEquipmentValidationResult",
        "type": "object"
      },
      "TruckloadExternalArrivalEstimate": {
        "description": "External arrival estimate object that contains the source and the actual date and time value.",
        "properties": {
          "dateTime": {
            "description": "The date and time value of the external arrival estimate. (format: yyyy-MM-dd'T'HH:mm:ssZ)",
            "type": "string"
          },
          "source": {
            "description": "The source of the external arrival estimate.",
            "enum": [
              "SHIPPER",
              "CARRIER",
              "UNKNOWN"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadExternalArrivalEstimate",
        "type": "object"
      },
      "TruckloadIntermediateStopsUpdate": {
        "description": "Update the intermediate stops on a shipment.",
        "properties": {
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "customerAccountNumber": {
            "type": "string"
          },
          "shipmentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentStops": {
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentIntermediateStop"
            },
            "type": "array"
          }
        },
        "title": "TruckloadIntermediateStopsUpdate",
        "type": "object"
      },
      "TruckLoadPreferenceType": {
        "enum": [
          "FULL",
          "PARTIAL"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "TruckloadRateQuoteDetail": {
        "properties": {
          "charges": {
            "description": "A list of individual charges making up the total. Not all capacity providers provide charge breakdowns.",
            "items": {
              "$ref": "#/components/schemas/TruckloadVendorCharge"
            },
            "type": "array"
          },
          "subtotal": {
            "description": "Subtotal prior to discounts.",
            "type": "number"
          },
          "total": {
            "description": "The final total for this quote.",
            "type": "number"
          }
        },
        "title": "TruckloadRateQuoteDetail",
        "type": "object"
      },
      "TruckloadShipment": {
        "properties": {
          "apiConfiguration": {
            "$ref": "#/components/schemas/TruckloadShipmentApiConfiguration"
          },
          "attributes": {
            "description": "A list of up to 25 attributes (name/value pairs) to associate with this shipment. These values will be returned unchanged with each status response for the shipment and can also be used to group together related shipments in reporting scenarios, e.g. all shipments tracked for \"division\":\"Central\".  The attribute names have to be unique within the list. These attributes may optionally be predefined by your organization's admin",
            "items": {
              "$ref": "#/components/schemas/ShipmentAttribute"
            },
            "type": "array"
          },
          "capacityProviderAccountGroup": {
            "$ref": "#/components/schemas/CapacityProviderAccountGroup"
          },
          "carrierIdentifier": {
            "$ref": "#/components/schemas/CapacityProviderIdentifier"
          },
          "contents": {
            "description": "Contents of the shipment, including product categories and set points for temperature sensitive shipments.",
            "items": {
              "$ref": "#/components/schemas/ShipmentContent"
            },
            "type": "array"
          },
          "equipmentIdentifierChanges": {
            "description": "A list of equipment identifier changes that should be applied to the shipment",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifierChange"
            },
            "type": "array"
          },
          "equipmentIdentifiers": {
            "description": "A user-defined list of equipment identifiers identifying truckload equipment that can be tracked, such as cell phones and electronic logging devices (ELDs). These need not be unique to this shipment.",
            "items": {
              "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
            },
            "type": "array"
          },
          "id": {
            "description": "The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.",
            "format": "int64",
            "type": "integer"
          },
          "idleDuration": {
            "description": "Computed value representing how long (in minutes) shipment is being Idle. This value is available while whole status history is being requested. ",
            "format": "int64",
            "type": "integer"
          },
          "masterShipmentId": {
            "description": "The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment.",
            "format": "uuid",
            "type": "string"
          },
          "pointsOfInterest": {
            "description": "A user-defined list of all the point of interest for the shipment.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentPointOfInterest"
            },
            "type": "array"
          },
          "sensors": {
            "description": "A list of sensors to track.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentSensor"
            },
            "type": "array"
          },
          "shipmentDetails": {
            "$ref": "#/components/schemas/TruckloadTrackingShipmentDetails"
          },
          "shipmentIdentifiers": {
            "description": "A user-defined list of shipment identifiers that are unique to this shipment and carrier identifier. These may be used in subsequent API calls along with the carrier identifier to reference a shipment. They may also be used by project44 to track the shipment. Only one shipment identifier of each type may be provided.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentIdentifier"
            },
            "type": "array"
          },
          "shipmentLegId": {
            "description": "The project44-generated id for the truckload shipment. This id may be used in subsequent API calls to reference a shipment.",
            "format": "uuid",
            "type": "string"
          },
          "shipmentStops": {
            "description": "A user-defined list of all the shipment stops for the shipment, including stop locations and appointment windows. This list must contain the shipment's origin and destination and any stops of interest in between (other pickup or delivery locations).",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentStop"
            },
            "type": "array"
          },
          "shippingDetails": {
            "$ref": "#/components/schemas/TruckloadShippingDetails"
          },
          "trackingDetails": {
            "description": "Contains information about how we obtain tracking data for the shipment. Currently, this list always includes either zero or one active tracking method. Future versions will be able to combine data from more than one tracking method. In that case, the primary tracking method will be listed first.",
            "items": {
              "$ref": "#/components/schemas/TruckloadTrackingMethodDetails"
            },
            "type": "array"
          }
        },
        "title": "TruckloadShipment",
        "type": "object"
      },
      "TruckloadShipmentAction": {
        "properties": {
          "code": {
            "description": "The code for the action to be taken on the shipment.",
            "enum": [
              "CANCEL"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadShipmentAction",
        "type": "object"
      },
      "TruckloadShipmentActionConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          }
        },
        "title": "TruckloadShipmentActionConfirmation",
        "type": "object"
      },
      "TruckloadShipmentApiConfiguration": {
        "description": "Contains fields used to configure the truckload shipment API.",
        "properties": {
          "enableIntelligentMatching": {
            "description": "If set to true, project44 will attempt to automatically assign an equipment identifier on the shipment for telematics enabled carriers. If validation passes by customer or carrier, that equipment identifier will take precedent. This does not include mobile phone numbers. If set to false, project44 will not automatically assign an equipment identifier on the shipment. (default: 'true')",
            "type": "boolean"
          },
          "fallBackToDefaultAccountGroup": {
            "description": "If set to 'true' and the provided capacity provider account group code is invalid, the default capacity provider account group will be used. When 'false', an error will be returned if the provided capacity provider account group code is invalid. (default: 'false')",
            "type": "boolean"
          },
          "webhookEndpointConfigName": {
            "description": "A unique name used to identify the Webhook Endpoint.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentApiConfiguration",
        "type": "object"
      },
      "TruckloadShipmentConfirmation": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/TruckloadShipment"
          }
        },
        "title": "TruckloadShipmentConfirmation",
        "type": "object"
      },
      "TruckloadShipmentHazmatDetails": {
        "description": "Contains fields that describe what hazardous materials the shipment contains, if any.",
        "properties": {
          "hazardClasses": {
            "description": "User-defined list of hazardous materials, if any that are included in the shipment.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "TruckloadShipmentHazmatDetails",
        "type": "object"
      },
      "TruckloadShipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the shipment identifier.",
            "enum": [
              "BILL_OF_LADING",
              "ORDER"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the shipment identifier.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentIdentifier",
        "type": "object"
      },
      "TruckloadShipmentIntermediateStop": {
        "properties": {
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "stopName": {
            "description": "The optionally user-defined name of this stop. This is a freeform field. Project44 will default the name of each stop based on the stop number, if no name is provided.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentIntermediateStop",
        "type": "object"
      },
      "TruckloadShipmentLineItem": {
        "description": "Contains fields that describe a TruckloadShipment LineItem.",
        "properties": {
          "commodityCode": {
            "description": "This code dictates the duty rating, as well as alerts you to any import or export restrictions.",
            "type": "string"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "deliveryStopNumber": {
            "description": "A reference to the stop number where this item will be delivered.",
            "format": "int32",
            "type": "integer"
          },
          "description": {
            "description": "Shipper's description for this item.",
            "type": "string"
          },
          "freightClass": {
            "description": "The freight class for this item.",
            "enum": [
              "50",
              "55",
              "60",
              "65",
              "70",
              "77.5",
              "85",
              "92.5",
              "100",
              "110",
              "125",
              "150",
              "175",
              "200",
              "250",
              "300",
              "400",
              "500"
            ],
            "type": "string"
          },
          "handlingUnitPackageType": {
            "description": "The packaging used to handle the lineItem during transport.",
            "enum": [
              "PLT",
              "BALE",
              "BOX",
              "BUNDLE",
              "CASE",
              "CRATE",
              "DRUM",
              "REEL",
              "ROLL",
              "SKID",
              "CONTAINER"
            ],
            "type": "string"
          },
          "handlingUnitQuantity": {
            "description": "Quantify of handling units (Cases, pallets, etc) that constitute the lineItem.",
            "format": "int32",
            "type": "integer"
          },
          "involvedParties": {
            "description": "A list of parties and their identifiers related to the line item. These are your customers receiving this line item or your suppliers providing this line item.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "itemIdentifiers": {
            "description": "Useful identifiers that can be attached to this item.",
            "items": {
              "$ref": "#/components/schemas/LineItemIdentifier"
            },
            "type": "array"
          },
          "itemPackageType": {
            "description": "The type of packaging used for the items inside the handling unit.",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PAIL",
              "PLT",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TUBE",
              "EACH",
              "FLAT",
              "LOOSE"
            ],
            "type": "string"
          },
          "itemQuantity": {
            "description": "The number of items inside the handling unit.",
            "format": "int32",
            "type": "integer"
          },
          "monetaryValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "pickupStopNumber": {
            "description": "A reference to the stop number where this item will be picked up.",
            "format": "int32",
            "type": "integer"
          },
          "subLineItems": {
            "description": "The sub-line items for this item.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentSubLineItem"
            },
            "type": "array"
          },
          "totalWeight": {
            "$ref": "#/components/schemas/Weight"
          }
        },
        "title": "TruckloadShipmentLineItem",
        "type": "object"
      },
      "TruckloadShipmentNotificationRule": {
        "description": "Contains fields describing properties of rule that triggered a push notification",
        "properties": {
          "ruleInfo": {
            "description": "Rule information per rule type:\n\n DEPRECATED_SHIPMENT_LATE : [( minutesLate : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n DEPRECATED_SHIPMENT_NEAR_ARRIVAL : [( minutesUntilArrival : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n DEPRECATED_SHIPMENT_DEPARTED : [( stopNumber : Long ), ( stopType : String )]\n\n ALL_UPDATES : []\n\n SHIPMENT_LATE : [( minutesLate : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n SHIPMENT_NEAR_ARRIVAL : [( minutesUntilArrival : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n SHIPMENT_DEPARTED : [( stopNumber : Long ), ( stopType : String )]\n\n SHIPMENT_TRACKING_APPROVAL_DENIED : []\n\n SHIPMENT_DWELLING : [( minutesDwelling : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n SHIPMENT_IDLE_IN_TRANSIT : [( minutesIdle : Long ), ( stopNumber : Long ), ( stopType : String )]\n\n TEMPERATURE_OUT_OF_RANGE : [( minutesTemperatureOutOfRange : Long )]\n\n TRACKING_APPROVAL_PENDING : [( minutesBeforeAppointmentWindow : Long )]",
            "properties": {},
            "type": "object"
          },
          "ruleType": {
            "description": "The rule type that triggered a push notification.",
            "enum": [
              "DEPRECATED_SHIPMENT_LATE",
              "DEPRECATED_SHIPMENT_NEAR_ARRIVAL",
              "DEPRECATED_SHIPMENT_DEPARTED",
              "ALL_UPDATES",
              "SHIPMENT_LATE",
              "SHIPMENT_NEAR_ARRIVAL",
              "SHIPMENT_DEPARTED",
              "SHIPMENT_TRACKING_APPROVAL_DENIED",
              "SHIPMENT_DWELLING",
              "SHIPMENT_IDLE_IN_TRANSIT",
              "TEMPERATURE_OUT_OF_RANGE",
              "TRACKING_APPROVAL_PENDING"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadShipmentNotificationRule",
        "type": "object"
      },
      "TruckloadShipmentPointOfInterest": {
        "properties": {
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "locationIdentifiers": {
            "description": "The identifiers associated with the user-defined point of interest location, to be used with the Stop Location API.",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifier"
            },
            "type": "array"
          },
          "pointOfInterestDescription": {
            "description": "The optionally user-defined description of this point of interest. This is a freeform field.",
            "type": "string"
          },
          "pointOfInterestId": {
            "description": "The user-defined id that uniquely identifies point of interest.",
            "type": "string"
          },
          "pointOfInterestName": {
            "description": "The optionally user-defined name of this point of interest. This is a freeform field. Project44 will default the name of each point of interest, if no name is provided.",
            "type": "string"
          },
          "pointOfInterestType": {
            "description": "The type of point of interest indicating whether this is a general point of interest or point of interest for truck change.",
            "enum": [
              "GENERAL",
              "TRUCK_CHANGE"
            ],
            "type": "string"
          },
          "shouldDelete": {
            "description": "Optional field to mark point of interest for deletion.",
            "type": "boolean"
          }
        },
        "title": "TruckloadShipmentPointOfInterest",
        "type": "object"
      },
      "TruckloadShipmentPointOfInterestRecordedEntry": {
        "properties": {
          "entryDateTime": {
            "description": "UTC time for entry event for that point of interest.",
            "type": "string"
          },
          "exitDateTime": {
            "description": "UTC time for exit event for that point of interest.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentPointOfInterestRecordedEntry",
        "type": "object"
      },
      "TruckloadShipmentPointOfInterestStatus": {
        "properties": {
          "pointOfInterestId": {
            "description": "The user-defined id that uniquely identifies point of interest.",
            "type": "string"
          },
          "recordedEntries": {
            "description": "The ordered list of all paired entries and exits events.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentPointOfInterestRecordedEntry"
            },
            "type": "array"
          },
          "totalDwellTime": {
            "description": "Total dwell time of truck inside of point of interest.",
            "format": "int64",
            "type": "integer"
          }
        },
        "title": "TruckloadShipmentPointOfInterestStatus",
        "type": "object"
      },
      "TruckloadShipmentSensor": {
        "properties": {
          "identifier": {
            "$ref": "#/components/schemas/TruckloadShipmentSensorIdentifier"
          },
          "max": {
            "description": "The max value for triggering over max status.",
            "format": "double",
            "type": "number"
          },
          "min": {
            "description": "The min value for triggering under min status.",
            "format": "double",
            "type": "number"
          },
          "target": {
            "description": "The target value.",
            "format": "double",
            "type": "number"
          }
        },
        "title": "TruckloadShipmentSensor",
        "type": "object"
      },
      "TruckloadShipmentSensorHistory": {
        "properties": {
          "readings": {
            "description": "The sensor's readings",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentSensorReading"
            },
            "type": "array"
          },
          "sensor": {
            "$ref": "#/components/schemas/TruckloadShipmentSensor"
          }
        },
        "title": "TruckloadShipmentSensorHistory",
        "type": "object"
      },
      "TruckloadShipmentSensorIdentifier": {
        "properties": {
          "type": {
            "description": "The type of the sensor identifier.",
            "enum": [
              "TEMPERATURE"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the sensor identifier.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentSensorIdentifier",
        "type": "object"
      },
      "TruckloadShipmentSensorReading": {
        "properties": {
          "utcTimestamp": {
            "description": "The UTC timestamp of the sensor reading.",
            "format": "date-time",
            "type": "string"
          },
          "value": {
            "description": "The value at the time of the sensor reading.",
            "format": "double",
            "type": "number"
          }
        },
        "title": "TruckloadShipmentSensorReading",
        "type": "object"
      },
      "TruckloadShipmentStatus": {
        "properties": {
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "latestStatusUpdate": {
            "$ref": "#/components/schemas/TruckloadShipmentStatusUpdate"
          },
          "latestStopStatuses": {
            "description": "The most up-to-date statuses of the vehicle in relation to each stop. One and only one status will always be returned for each stop. If the shipment does not have status 'COMPLETED' or 'DISPATCHED', this list will always contain one and only one stop status with a code of either 'EN_ROUTE' or 'ARRIVED'.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentStopStatus"
            },
            "type": "array"
          },
          "mapUrl": {
            "description": "Publicly accessible URL to the shipment details page.",
            "type": "string"
          },
          "notificationRule": {
            "$ref": "#/components/schemas/TruckloadShipmentNotificationRule"
          },
          "pointOfInterestStatus": {
            "description": "A list of status and their identifiers related to the point of interest.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentPointOfInterestStatus"
            },
            "type": "array"
          },
          "sensorHistories": {
            "description": "If requested, all available shipment sensor histories.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentSensorHistory"
            },
            "type": "array"
          },
          "shipment": {
            "$ref": "#/components/schemas/TruckloadShipment"
          },
          "statusUpdates": {
            "description": "If requested, all available shipment status updates.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentStatusUpdate"
            },
            "type": "array"
          }
        },
        "title": "TruckloadShipmentStatus",
        "type": "object"
      },
      "TruckloadShipmentStatusReason": {
        "properties": {
          "code": {
            "description": "The reason code for the status of the status update. A status of 'DISPATCHED' will have one of the following reason codes: 'PENDING_TRACKING_METHOD', 'SCHEDULED', 'PENDING_APPROVAL', 'PENDING_CARRIER' or 'ACQUIRING_LOCATION'. A status of 'IN_TRANSIT' will have one of the following reason codes: 'IN_MOTION' or 'IDLE'. A status of 'AT_STOP' will not have a reason. A status of 'COMPLETED' will have one of the following reason codes: 'APPROVAL_DENIED', 'TIMED_OUT', 'CANCELED', or 'DEPARTED_FINAL_STOP'.",
            "enum": [
              "PENDING_TRACKING_METHOD",
              "SCHEDULED",
              "PENDING_APPROVAL",
              "ACQUIRING_LOCATION",
              "PENDING_CARRIER",
              "IN_MOTION",
              "IDLE",
              "APPROVAL_DENIED",
              "TIMED_OUT",
              "CANCELED",
              "DEPARTED_FINAL_STOP",
              "ARRIVED_FINAL_STOP",
              "FAILED_TO_ACQUIRE_LOCATION",
              "INFO"
            ],
            "type": "string"
          },
          "description": {
            "description": "A description of the reason for the status of the status update.",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentStatusReason",
        "type": "object"
      },
      "TruckloadShipmentStatusUpdate": {
        "properties": {
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "statusCode": {
            "description": "The status code for this status update. This field will always be populated.",
            "enum": [
              "DISPATCHED",
              "IN_TRANSIT",
              "AT_STOP",
              "COMPLETED",
              "TRACKING_FAILED",
              "INFO",
              "DELETED"
            ],
            "type": "string"
          },
          "statusReason": {
            "$ref": "#/components/schemas/TruckloadShipmentStatusReason"
          },
          "stopNumber": {
            "description": "The stop number to which this status update corresponds, if any. For example, a status update with status code 'AT_STOP' will always have this field populated with the stop number the vehicle is at.",
            "format": "int32",
            "type": "integer"
          },
          "timestamp": {
            "description": "The timestamp of this status update in the time zone of the location. If this status update has no location, this timestamp will be in UTC. A time zone offset will always be provided. This field will always be populated (format: yyyy-MM-dd'T'HH:mm:ssZ).",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentStatusUpdate",
        "type": "object"
      },
      "TruckloadShipmentStop": {
        "properties": {
          "additionalAppointmentWindows": {
            "description": "Optional user-defined field in which one or many additional appointment   windows can be provided on the stop. The associated appointmentWindow values will always be the default window in terms of measuring on   time performance. The time zone identifier (e.g., 'America/Chicago') for this date time window is an optional field. If not provided the   system will default to the timezone local to the stop. Please note, we will always report back the timezone for the additional appointment   window as local to the stop.",
            "items": {
              "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindow"
            },
            "type": "array"
          },
          "appointmentWindow": {
            "$ref": "#/components/schemas/ZonedDateTimeWindow"
          },
          "externalArrivalEstimate": {
            "$ref": "#/components/schemas/TruckloadExternalArrivalEstimate"
          },
          "geoCoordinates": {
            "$ref": "#/components/schemas/GeoCoordinates"
          },
          "involvedParties": {
            "description": "A list of parties and their identifiers related to the shipment stop. These are your customers receiving freight at this stop or your suppliers providing freight from this stop. This field is only functional in tracking at this time.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "location": {
            "$ref": "#/components/schemas/Location"
          },
          "locationIdentifiers": {
            "description": "The identifiers associated with the user-defined stop location,  to be used with the Stop Location API.",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifier"
            },
            "type": "array"
          },
          "stopDescription": {
            "description": "Description related to the stop.",
            "type": "string"
          },
          "stopName": {
            "description": "The optionally user-defined name of this stop. This is a freeform field. Project44 will default the name of each stop based on the stop number, if no name is provided.",
            "type": "string"
          },
          "stopNumber": {
            "description": "The user-defined stop number, where '1' is for the origin and the destination has the   largest number, with any stops in between ordered by appointment time.",
            "format": "int32",
            "type": "integer"
          },
          "stopType": {
            "description": "The type of stop indicating whether this stop is a pickup location, destination location, or both.",
            "enum": [
              "PICKUP",
              "DELIVERY",
              "DELIVERY_PICKUP"
            ],
            "type": "string"
          },
          "uuid": {
            "description": "UUID that uniquely identifies stop. Automatically generated when shipment is created and will be ignored if provided in the POST request. In a PUT request, will use a provided stop UUID only if it matches an already-persisted stop UUID, and returns a 400 if it does not match any. If no stop UUID is provided in a PUT request, will check whether the provided stop is effectively the same as an already persisted stop and will use the existing UUID if that's the case. Otherwise, will generate and return a new UUID in response to the PUT request. Here, two shipment stops are considered effectively the same if they match across stop number, tenant location id, stop name, stop type, and involved parties.",
            "format": "uuid",
            "type": "string"
          }
        },
        "title": "TruckloadShipmentStop",
        "type": "object"
      },
      "TruckloadShipmentStopStatus": {
        "properties": {
          "additionalAppointmentWindowStatuses": {
            "description": "A calculated list of additional appointment windows statuses for each additional appointment window of a given type at this stop. Valid status code values are EARLY, ON_TIME and LATE.",
            "items": {
              "$ref": "#/components/schemas/TruckloadAdditionalAppointmentWindowStatus"
            },
            "type": "array"
          },
          "arrivalCode": {
            "description": "The approximate arrival status of the vehicle at the stop, as recorded. The arrival status is relative to the user-defined appointment window for the stop.",
            "enum": [
              "UNKNOWN",
              "EARLY",
              "ON_TIME",
              "LATE"
            ],
            "type": "string"
          },
          "arrivalDateTime": {
            "description": "The recorded arrival time of the vehicle at this stop, if available. This time will always be in the time zone of the stop, and a time zone offset will always be provided (format: yyyy-MM-dd'T'HH:mm:ssZ).",
            "type": "string"
          },
          "arrivalEstimate": {
            "$ref": "#/components/schemas/TruckloadArrivalEstimate"
          },
          "departureDateTime": {
            "description": "The recorded departure time of the vehicle from this stop, if available. This time will always be in the time zone of the stop, and a time zone offset will always be provided (format: yyyy-MM-dd'T'HH:mm:ssZ).",
            "type": "string"
          },
          "statusCode": {
            "description": "The status of the vehicle relative to this stop -- whether it is presumed to be currently en route to the stop or whether it has been recorded as having arrived or departed the stop.",
            "enum": [
              "UNKNOWN",
              "EN_ROUTE",
              "ARRIVED",
              "DEPARTED"
            ],
            "type": "string"
          },
          "stopNumber": {
            "description": "The number of the shipment stop to which this status pertains.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "TruckloadShipmentStopStatus",
        "type": "object"
      },
      "TruckloadShipmentSubLineItem": {
        "description": "Contains fields that describe a TruckloadShipment SubLineItem.",
        "properties": {
          "commodityCode": {
            "description": "This code dictates the duty rating, as well as alerts you to any import or export restrictions.",
            "type": "string"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "description": {
            "description": "Shipper's description for this item.",
            "type": "string"
          },
          "freightClass": {
            "description": "The freight class for this item.",
            "enum": [
              "50",
              "55",
              "60",
              "65",
              "70",
              "77.5",
              "85",
              "92.5",
              "100",
              "110",
              "125",
              "150",
              "175",
              "200",
              "250",
              "300",
              "400",
              "500"
            ],
            "type": "string"
          },
          "involvedParties": {
            "description": "A list of parties and their identifiers related to the line item. These are your customers receiving this line item or your suppliers providing this line item.",
            "items": {
              "$ref": "#/components/schemas/Party"
            },
            "type": "array"
          },
          "itemIdentifiers": {
            "description": "Useful identifiers that can be attached to this item.",
            "items": {
              "$ref": "#/components/schemas/LineItemIdentifier"
            },
            "type": "array"
          },
          "itemPackageType": {
            "description": "The type of packaging used for the items inside the handling unit.",
            "enum": [
              "BAG",
              "BALE",
              "BOX",
              "BUCKET",
              "BUNDLE",
              "CAN",
              "CARTON",
              "CASE",
              "COIL",
              "CRATE",
              "CYLINDER",
              "DRUM",
              "PAIL",
              "PLT",
              "PIECES",
              "REEL",
              "ROLL",
              "SKID",
              "TOTE",
              "TUBE",
              "EACH",
              "FLAT",
              "LOOSE"
            ],
            "type": "string"
          },
          "itemQuantity": {
            "description": "The number of items inside the handling unit.",
            "format": "int32",
            "type": "integer"
          },
          "monetaryValue": {
            "$ref": "#/components/schemas/MonetaryValue"
          },
          "totalWeight": {
            "$ref": "#/components/schemas/Weight"
          }
        },
        "title": "TruckloadShipmentSubLineItem",
        "type": "object"
      },
      "TruckloadShipmentTrackingMethod": {
        "properties": {
          "capacityProviderAccount": {
            "$ref": "#/components/schemas/CapacityProviderAccount"
          },
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
          },
          "infoMessages": {
            "description": "System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here. These will provide more details about the shipment identifier and/or equipment identifier to provide.",
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "type": "array"
          },
          "shipmentIdentifier": {
            "$ref": "#/components/schemas/TruckloadShipmentIdentifier"
          }
        },
        "title": "TruckloadShipmentTrackingMethod",
        "type": "object"
      },
      "TruckloadShipmentTrackingMethods": {
        "properties": {
          "trackingMethods": {
            "description": "An ordered list of tracking methods that can be used to track a shipment, with the most robust method available listed first. When creating a shipment, provide as many shipment identifiers and equipment identifiers as possible that match the ones in the tracking methods in this list, preferring ones first in the list over others. Each tracking method will contain either a shipment identifier or an equipment identifier, or both.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentTrackingMethod"
            },
            "type": "array"
          }
        },
        "title": "TruckloadShipmentTrackingMethods",
        "type": "object"
      },
      "TruckloadShipmentTruckDetails": {
        "description": "Contains fields describing properties of the truck.",
        "properties": {
          "truckDimensions": {
            "$ref": "#/components/schemas/TruckloadShipmentTruckDimensions"
          },
          "truckType": {
            "description": "The type of truck being requested.",
            "enum": [
              "AUTO_CARRIER",
              "B_TRAIN",
              "CONESTOGA",
              "CONTAINER",
              "CONTAINER_INSULATED",
              "CONTAINER_REFRIGERATED",
              "CONVEYOR",
              "DOUBLE_DROP",
              "DROP_DECK_LANDOLL",
              "DUMP_TRAILER",
              "FLAT_BED",
              "FLATBED_AIR_RIDE",
              "FLATBED_CONESTOGA",
              "FLATBED_DOUBLE",
              "FLATBED_HAZMAT",
              "FLATBED_HOTSHOT",
              "FLATBED_MAXI",
              "FLATBED_STEP_DECK",
              "FLATBED_OVERDOMENSION",
              "FLATBED_OVERDIMENSION",
              "FLATBED_CHAINS",
              "FLATBED_SIDES",
              "FLATBED_TARPS",
              "FLATBED_TEAM",
              "FLATBED_VAN_REEFER",
              "HOPPER_BOTTOM",
              "INSULATED_VAN_REEFER",
              "LOWBOY",
              "LOWBOY_REM_GOOSENECK",
              "LOWBOY_OVERDIMENSION",
              "MOVING_VAN",
              "PNEUMATIC",
              "POWER_ONLY",
              "REEFER",
              "REEFER_AIR_RIDE",
              "REEFER_DOUBLE",
              "REEFER_HAZMAT",
              "REEFER_INTERMODAL",
              "REEFER_LOGISTICS",
              "REEFER_VENTED_VAN",
              "REEFER_PALLET_EXCHANGE",
              "REEFER_TEAM",
              "REMOVABLE_GOOSENECK",
              "STEP_DECK",
              "STEP_DECK_REM_GOOSENECK",
              "STEP_DECK_CONESTOGA",
              "STRAIGHT_BOX_TRUCK",
              "STRETCH_TRAILER",
              "TANKER_ALUMINUM",
              "TANKER_INTERMODAL",
              "TANKER_STEEL",
              "TRUCK_AND_TRAILER",
              "DRY_VAN",
              "VAN",
              "VAN_AIR_RIDE",
              "VAN_BLANKET_WRAP",
              "VAN_CONESTOGA",
              "VAN_DOUBLE",
              "VAN_HAZMAT",
              "VAN_HOTSHOT",
              "VAN_INSULATED",
              "VAN_INTERMODAL",
              "VAN_LIFT_GATE",
              "VAN_LOGISTICS",
              "VAN_OPEN_TOP",
              "VAN_FLATBED",
              "VAN_FLATBED_TARPS",
              "VAN_FLATBET",
              "VAN_FLATBET_TARPS",
              "VAN_REEFER",
              "VAN_PALLET_EXCHANGE",
              "VAN_ROLLER_BED",
              "VAN_TRIPLE",
              "VAN_VENTED",
              "VAN_CURTAINS",
              "VAN_TEAM"
            ],
            "type": "string"
          },
          "weight": {
            "description": "Indicates the weight of the truck where excessive weight may require the driver to choose alternative routes.",
            "format": "int32",
            "type": "integer"
          },
          "weightUnitOfMeasure": {
            "description": "Weight measurement units (default: 'LB').",
            "enum": [
              "LB",
              "KG"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadShipmentTruckDetails",
        "type": "object"
      },
      "TruckloadShipmentTruckDimensions": {
        "description": "Contains fields describing the size of the truck.",
        "properties": {
          "height": {
            "description": "Indicates the height of the truck where excessive lengths may require the driver to choose alternative routes.",
            "type": "number"
          },
          "length": {
            "description": "Indicates the length of the truck where excessive lengths may require the driver to choose alternative routes.",
            "type": "number"
          },
          "unitOfMeasure": {
            "description": "Length measurement units (default: 'FT').",
            "enum": [
              "IN",
              "CM",
              "FT",
              "M"
            ],
            "type": "string"
          },
          "width": {
            "description": "Indicates the width of the truck where excessive lengths may require the driver to choose alternative routes.",
            "type": "number"
          }
        },
        "title": "TruckloadShipmentTruckDimensions",
        "type": "object"
      },
      "TruckloadShippingDetails": {
        "description": "Contains fields which influence the way project44 calculates arrival estimates for stops.",
        "properties": {
          "hazmatDetails": {
            "$ref": "#/components/schemas/TruckloadShipmentHazmatDetails"
          },
          "multipleDrivers": {
            "description": "If set to 'true', indicates that the shipment is using a team of drivers and is therefore not constrained by the \"11 hours of service\" limit for an individual driver. This allows project44 to change its estimations around when a shipment can, and cannot be delivered.",
            "type": "boolean"
          },
          "truckDetails": {
            "$ref": "#/components/schemas/TruckloadShipmentTruckDetails"
          }
        },
        "title": "TruckloadShippingDetails",
        "type": "object"
      },
      "TruckloadTenderTrackingShipmentIdentifier": {
        "properties": {
          "type": {
            "description": "The type of this tendered shipment identifier.",
            "enum": [
              "BILL_OF_LADING",
              "ORDER",
              "TRACKING_IDENTIFIER"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value for this tendered shipment identifier.",
            "type": "string"
          }
        },
        "title": "TruckloadTenderTrackingShipmentIdentifier",
        "type": "object"
      },
      "TruckloadTrackingMethodDetails": {
        "description": "Contains information about how we obtain tracking data for the shipment. Currently this list always includes either zero or one active tracking method. Future versions will be able to combine data from more than one tracking method. In that case, the primary tracking method will be listed first.",
        "properties": {
          "equipmentIdentifier": {
            "$ref": "#/components/schemas/TruckloadEquipmentIdentifier"
          },
          "equipmentIdentifierSource": {
            "description": "Source of the equipment identifier assigned to the shipment.",
            "enum": [
              "CUSTOMER",
              "CARRIER",
              "AUTOMATIC"
            ],
            "type": "string"
          },
          "trackingType": {
            "description": "Type of the tracking data source.",
            "enum": [
              "MOBILE_PHONE",
              "TELEMATICS",
              "API"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadTrackingMethodDetails",
        "type": "object"
      },
      "TruckloadTrackingShipmentDetails": {
        "description": "Contains fields which pertain to the shipment contents.",
        "properties": {
          "lineItems": {
            "description": "Line Items for this shipment.",
            "items": {
              "$ref": "#/components/schemas/TruckloadShipmentLineItem"
            },
            "type": "array"
          }
        },
        "title": "TruckloadTrackingShipmentDetails",
        "type": "object"
      },
      "TruckloadVendorCharge": {
        "properties": {
          "amount": {
            "description": "The requested or actual amount charged by the capacity provider (adds into the total). This amount may be negative.",
            "type": "number"
          },
          "description": {
            "description": "The description of this charge, if provided.",
            "type": "string"
          },
          "vendorCode": {
            "description": "The code for this charge, as defined in the capacity provider's metadata.",
            "enum": [
              "LH",
              "FSC"
            ],
            "type": "string"
          }
        },
        "title": "TruckloadVendorCharge",
        "type": "object"
      },
      "TypeWrapper": {
        "required": [],
        "type": "object",
        "properties": {
          "operator": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Operator"
              }
            ],
            "default": "EQUALS"
          },
          "values": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DocumentType"
            },
            "description": "The list of document type to be search for"
          }
        }
      },
      "UnifiedWebhookContext": {
        "type": "object",
        "properties": {
          "route": {
            "$ref": "#/components/schemas/UnifiedWebhookRouteContext"
          },
          "relatedShipments": {
            "$ref": "#/components/schemas/UnifiedWebhookRelatedShipmentsContext"
          },
          "shipment": {
            "$ref": "#/components/schemas/UnifiedWebhookShipmentContext"
          }
        }
      },
      "UnifiedWebhookEventChangeNotification": {
        "type": "object",
        "properties": {
          "event": {
            "$ref": "#/components/schemas/TrackedShipmentEvent"
          }
        }
      },
      "UnifiedWebhookExceptionChangeNotification": {
        "type": "object",
        "properties": {
          "exceptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentException"
            }
          }
        }
      },
      "UnifiedWebhookInterface": {
        "type": "object",
        "properties": {
          "createdDateTime": {
            "type": "string",
            "description": "The time when project44 created the event.",
            "format": "date-time"
          },
          "dataType": {
            "type": "string",
            "description": "Data type of the payload"
          },
          "eventId": {
            "type": "string",
            "description": "Unique identifier for the event"
          },
          "eventType": {
            "type": "string",
            "description": "Describes the type of the event"
          }
        },
        "description": "Unified interface for webhook"
      },
      "UnifiedWebhookMessage": {
        "type": "object",
        "properties": {
          "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the event was created in ISO format."
          },
          "context": {
            "$ref": "#/components/schemas/UnifiedWebhookContext"
          },
          "dataType": {
            "type": "string",
            "description": "The type of data contained in the payload."
          },
          "data": {
            "type": "object",
            "properties": {
              "eventNotification": {
                "$ref": "#/components/schemas/UnifiedWebhookEventChangeNotification"
              },
              "stateNotification": {
                "$ref": "#/components/schemas/UnifiedWebhookStateChangeNotification"
              },
              "routeInfoNotification": {
                "$ref": "#/components/schemas/UnifiedWebhookRouteInfoChangeNotification"
              },
              "exceptionNotification": {
                "$ref": "#/components/schemas/UnifiedWebhookExceptionChangeNotification"
              },
              "deletedShipment": {
                "$ref": "#/components/schemas/UnifiedWebhookShipmentIdNotification"
              }
            }
          },
          "eventId": {
            "type": "string",
            "description": "A unique identifier for the event."
          },
          "eventType": {
            "type": "string",
            "description": "The type of event that triggered the webhook."
          }
        }
      },
      "UnifiedWebhookRelatedShipmentsContext": {
        "type": "object",
        "properties": {
          "relatedShipments": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The unique identifier for a related shipment."
            }
          }
        }
      },
      "UnifiedWebhookRouteContext": {
        "type": "object",
        "properties": {
          "routeSegments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentRouteSegment"
            }
          },
          "stops": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentStop"
            }
          }
        }
      },
      "UnifiedWebhookRouteInfoChangeNotification": {
        "type": "object",
        "properties": {
          "routeSegments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentRouteSegment"
            }
          },
          "stops": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrackedShipmentStop"
            }
          }
        }
      },
      "UnifiedWebhookShipmentContext": {
        "type": "object",
        "properties": {
          "attributes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the shipment was created in ISO format."
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "lastModifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the shipment was last modified in ISO format."
          },
          "shipmentId": {
            "type": "string",
            "description": "The unique identifier for the shipment."
          },
          "shipmentShareLink": {
            "type": "string",
            "description": "A URL link to view the shipment details."
          }
        }
      },
      "UnifiedWebhookShipmentIdNotification": {
        "type": "object",
        "properties": {
          "shipmentId": {
            "type": "string"
          }
        }
      },
      "UnifiedWebhookStateChangeNotification": {
        "type": "object",
        "properties": {
          "state": {
            "$ref": "#/components/schemas/TrackedShipmentState"
          }
        }
      },
      "UpdateBookedShipment": {
        "required": [],
        "type": "object",
        "properties": {
          "attributes": {
            "maxItems": 5,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            },
            "description": "An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers."
          },
          "bookings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateUpdateBookingWithId"
            },
            "description": "A list of all bookings related to the shipment."
          },
          "identifiers": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LogisticsIdentifier"
            }
          },
          "name": {
            "type": "string",
            "description": "The descriptive name or otherwise human-readable description of the shipment created; this is not visible to the carrier."
          },
          "notes": {
            "maxLength": 300,
            "type": "string",
            "description": "An optional, shipper-provided free-text space for notes on the shipment."
          },
          "routeInfo": {
            "$ref": "#/components/schemas/RouteInfo"
          }
        },
        "description": "The overall shipper's construct of the material good(s) to be transported by the carrier."
      },
      "VehicleInfo": {
        "description": "Describes vehicle information used to compute emissions.",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/VehicleType"
          },
          "weight": {
            "$ref": "#/components/schemas/WeightMeasurement"
          }
        },
        "title": "VehicleInfo",
        "type": "object"
      },
      "VehicleShipmentIdentifier": {
        "required": [],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "VEHICLE_ID",
              "VESSEL_IMO",
              "VESSEL_NAME",
              "FLIGHT_NUMBER",
              "DRIVER_MOBILE_PHONE_NUMBER",
              "VESSEL_MMSI",
              "VESSEL_CALL_SIGN",
              "LICENSE_PLATE",
              "TRAIN_NUMBER",
              "WAGON_ID",
              "UNKNOWN"
            ]
          },
          "value": {
            "type": "string"
          }
        }
      },
      "VehicleType": {
        "properties": {
          "enumValue": {
            "enum": [
              "UNKNOWN",
              "AIR_FREIGHTER",
              "AIR_BELLY_FREIGHT",
              "AIR_UNKNOWN",
              "INLAND_WATERWAY_MOTOR_VESSEL_LT_650T",
              "INLAND_WATERWAY_MOTOR_VESSEL_650T_TO_1000T",
              "INLAND_WATERWAY_MOTOR_VESSEL_1000T_TO_2000T",
              "INLAND_WATERWAY_MOTOR_VESSEL_2000T_TO_3000T",
              "INLAND_WATERWAY_COUPLED_CONVOY",
              "INLAND_WATERWAY_PUSHED_CONVOY_2_TO_3_BARGES",
              "INLAND_WATERWAY_PUSHED_CONVOY_4_TO_5_BARGES",
              "INLAND_WATERWAY_PUSHED_CONVOY_6_BARGES",
              "INLAND_WATERWAY_TANKER_VESSELS",
              "INLAND_WATERWAY_CONTAINER_VESSELS_110M",
              "INLAND_WATERWAY_CONTAINER_VESSELS_135M",
              "INLAND_WATERWAY_CONTAINER_VESSELS_COUPLED_CONVOY",
              "RAIL_AVERAGE_MIXED",
              "RAIL_CONTAINER",
              "RAIL_CARS",
              "RAIL_CHEMICALS",
              "RAIL_COAL_STEEL",
              "RAIL_BUILDING_MATERIALS",
              "RAIL_MANUFACTURED_PRODUCTS",
              "RAIL_CEREALS",
              "RAIL_TRUCK_AND_TRAILER",
              "RAIL_TRAILER_ONLY",
              "ROAD_NA_VAN",
              "ROAD_NA_GENERAL",
              "ROAD_NA_AUTO_CARRIER",
              "ROAD_NA_DRAY",
              "ROAD_NA_EXPEDITED",
              "ROAD_NA_FLATBED",
              "ROAD_NA_HEAVY_BULK",
              "ROAD_NA_LTL_DRY_VAN",
              "ROAD_NA_MIXED",
              "ROAD_NA_MOVING",
              "ROAD_NA_PACKAGE",
              "ROAD_NA_REFRIGERATED",
              "ROAD_NA_SPECIALIZED",
              "ROAD_NA_TANKER",
              "ROAD_NA_TL_DRY_VAN",
              "ROAD_GLOBAL_VAN_LT_3500KG",
              "ROAD_GLOBAL_RIGID_TRUCK_3500KG_TO_7500KG",
              "ROAD_GLOBAL_RIGID_TRUCK_7500KG_TO_12T_GVW",
              "ROAD_GLOBAL_RIGID_TRUCK_12T_20T_GVW",
              "ROAD_GLOBAL_RIGID_TRUCK_20T_TO_26T_GVW",
              "ROAD_GLOBAL_RIGID_TRUCK_26T_TO_32T_GVW",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_34T_GVW",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW_SI_ENGINE",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW_HPDI",
              "ROAD_GLOBAL_ARTIC_TRUCK_40T_GVW_LIGHTWEIGHT_TRAILER",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_44T_GVW",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_60T_GVW",
              "ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_72T_GVW",
              "OCEAN_BULK_CARRIER_0_TO_9999_DWT",
              "OCEAN_BULK_CARRIER_10000_TO_34999_DWT",
              "OCEAN_BULK_CARRIER_35000_TO_59999_DWT",
              "OCEAN_BULK_CARRIER_60000_TO_99999_DWT",
              "OCEAN_BULK_CARRIER_100000_TO_199999_DWT",
              "OCEAN_BULK_CARRIER_200000_AND_UP_DWT",
              "OCEAN_CHEMICAL_TANKER_0_TO_4999_DWT",
              "OCEAN_CHEMICAL_TANKER_5000_TO_9999_DWT",
              "OCEAN_CHEMICAL_TANKER_10000_TO_19999_DWT",
              "OCEAN_CHEMICAL_TANKER_20000_TO_39999_DWT",
              "OCEAN_CHEMICAL_TANKER_40000_AND_UP_DWT",
              "OCEAN_GENERAL_CARGO_0_TO_4999_DWT",
              "OCEAN_GENERAL_CARGO_5000_TO_9999_DWT",
              "OCEAN_GENERAL_CARGO_10000_TO_19999_DWT",
              "OCEAN_GENERAL_CARGO_20000_AND_UP_DWT",
              "OCEAN_LNG_TANKER_0_TO_49999_CBM",
              "OCEAN_LNG_TANKER_50000_TO_99999_CBM",
              "OCEAN_LNG_TANKER_100000_TO_199999_CBM",
              "OCEAN_LNG_TANKER_200000_AND_UP_CBM",
              "OCEAN_OIL_TANKER_0_TO_4999_DWT",
              "OCEAN_OIL_TANKER_5000_TO_9999_DWT",
              "OCEAN_OIL_TANKER_10000_TO_19999_DWT",
              "OCEAN_OIL_TANKER_20000_TO_59999_DWT",
              "OCEAN_OIL_TANKER_60000_TO_79999_DWT",
              "OCEAN_OIL_TANKER_80000_TO_119999_DWT",
              "OCEAN_OIL_TANKER_120000_TO_199999_DWT",
              "OCEAN_OIL_TANKER_200000_AND_UP_DWT",
              "OCEAN_OTHER_LIQUIDS_TANKER_0_TO_999_DWT",
              "OCEAN_OTHER_LIQUIDS_TANKER_1000_AND_UP_DWT",
              "OCEAN_FERRY_ROPAX_0_TO_1999_GT",
              "OCEAN_FERRY_ROPAX_2000_TO_4999_GT",
              "OCEAN_FERRY_ROPAX_5000_TO_9999_GT",
              "OCEAN_FERRY_ROPAX_10000_TO_19999_GT",
              "OCEAN_FERRY_ROPAX_20000_AND_UP_GT",
              "OCEAN_REFRIGERATED_BULK_0_TO_1999_DWT",
              "OCEAN_REFRIGERATED_BULK_2000_TO_5999_DWT",
              "OCEAN_REFRIGERATED_BULK_6000_TO_9999_DWT",
              "OCEAN_REFRIGERATED_BULK_10000_AND_UP_DWT",
              "OCEAN_CONTAINER_AVERAGE"
            ],
            "type": "string"
          }
        },
        "title": "VehicleType",
        "type": "object"
      },
      "VesselSchedule": {
        "properties": {
          "date": {
            "description": "The first date in this timespan, in ISO-8601 format",
            "type": "string"
          },
          "vesselsApproaching": {
            "description": "Number of vessels having the port as their destination on the given day.",
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "VesselSchedule",
        "type": "object"
      },
      "VesselTrackingConfig": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean",
            "description": "Indicates whether vessel tracking is enabled for this shipment."
          },
          "plannedVesselRouteSegments": {
            "type": "array",
            "description": "Planned vessel route segments with identifiers for this shipment. This is used to determine whether the shipment is on a planned route.",
            "items": {
              "$ref": "#/components/schemas/PlannedVesselRouteSegment"
            }
          }
        },
        "description": "Configuration for vessel tracking on a shipment."
      },
      "Volume": {
        "properties": {
          "unit": {
            "description": "The unit of measurement for this volume.",
            "enum": [
              "CUBIC_FT",
              "CUBIC_M",
              "L",
              "HL"
            ],
            "type": "string"
          },
          "value": {
            "description": "The numeric decimal value of this volume.",
            "type": "number"
          }
        },
        "title": "Volume",
        "type": "object"
      },
      "VolumeLtlDetails": {
        "type": "object",
        "properties": {
          "capacityProviderAccountGroup": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CapacityProviderAccountGroup"
              }
            ],
            "description": "The requested capacity provider account group containing the account used for authentication with the capacity provider's API."
          },
          "totalLinearFeet": {
            "type": "integer",
            "description": "The total linear feet that the shipment being quoted will take up in a trailer. Required only for volume LTL shipments ",
            "default": 0
          }
        }
      },
      "WebhookAuthenticationMethod": {
        "properties": {
          "parameters": {
            "description": "The webhookAuthenticationMethod parameters. The fields of a 'parameters' object vary for each authentication method. All fields are strings unless noted otherwise.<br/><br/>\n\n<ul style=\"list-style-type:none;\"><li><b>API Key authentication</b> - A new HTTP header is created for each supplied api key (max 2).  Example in cURL:  --header 'api_key_name:api_key' </li><li>Fields:</li><li><ul><li><b>api_key_name</b>: The name of the HTTP header that holds the API key.</li><li><b>api_key</b>: The value that will be sent in the HTTP header (the actual API Key).</li></ul></li><li><b>Basic authentication</b> - Applied to the 'Authorization' header with the 'Basic' identifier. Values are concatenated (with a separating colon character) and encoded to base64.</li><li>Fields:</li><li><ul><li><b>username</b>: Username for authentication.</li><li><b>password</b>: Password for authentication.</li></ul><li><b>OAuth2 authentication</b> - The OAuth2 bearer token is generated then applied to the 'Authorization' header with the 'Bearer' identifier.</li><li>Fields:</li><li><ul><li><b>grantType</b>: Type of authentication granted to the OAuth2 provider. Currently only 'client_credentials' is supported.</li><li><b>accessTokenUri</b>: Endpoint used to grant the bearer token</li><li><b>clientId</b>: Unique client identifier</li><li><b>clientSecret</b>: Authentication key for the client; functionally similar to a password</li><li><b>clientAuthenticationScheme</b>: Identifies whether the OAuth2 fields are supplied to the authorization granter in the header or the request body. Accepted values are 'header' and 'form'.</li><li><b>extraParams</b>: Optional - A key/value map containing additional query parameters to be added to the request to the access token provider.</li><li><b>extraHeaders</b>: Optional - A key/value map containing additional headers to be added to the request to the access token provider.</li></ul></li><li><b>MTLS authentication</b> - Mutual TLS relies on a two-way handshaking when establishing an HTTPS connection. After the client verifies the server certificate (as normal in TLS), the server requests a certificate from the client and verifies it. This way both the client and server are authenticated to each other.</li><li>Fields:</li><li><ul><li><b>pemCertificateChain</b>: PEM-formatted client cert(s)</li><li><b>pemPrivateKey</b>: PEM-formatted private key</li><li><b>pemEndpointCertificate</b>: Optional - PEM-formatted trusted CA cert.</li></ul></li><li><b>Azure cert-based OAuth2 authentication</b> - This authentication type uses the Azure certificate-based OAuth2 implementation documented <a href=\"https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow#second-case-access-token-request-with-a-certificate\">here</a>.</li><li>Fields:</li><li><ul><li><b>grantType</b>: Type of authentication granted to the OAuth2 provider. Currently only 'client_credentials' is supported.</li><li><b>accessTokenUri</b>: Endpoint used to grant the bearer token</li><li><b>clientId</b>: Microsoft client ID</li><li><b>tokenName</b>: Set to \"client_assertion\"/li><li><b>scope</b>: List of OAuth2 scopes</li><li><b>clientAuthenticationScheme</b>: Identifies whether the OAuth2 fields are supplied to the authorization granter in the header or the request body. Accepted values are 'header' and 'form'.</li><li><b>authorizationScheme</b>: Set to \"header\"</li><li><b>pemCertificate</b>: PEM-formatted cert </li><li><b>pemPrivateKey</b>: PEM-formatted key </li><li><b>extraParams</b>: </li><li><ul><li><b>audience</b>: https://login.microsoftonline.com/<Microsoft Tenant Id>/oauth2/v2.0/token</li><li><b>tenant</b>: Microsoft Tenant Id</li></ul></li><li><b>extraHeaders</b>: Optional - A key/value map containing additional headers to be added to the request to the access token provider.</li></ul></li></ul>",
            "properties": {},
            "type": "object"
          },
          "type": {
            "description": "The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported.",
            "enum": [
              "API_KEY",
              "BASIC",
              "OAUTH2",
              "MTLS",
              "AD_OAUTH2_CERT"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "WebhookEndpoint": {
        "properties": {
          "authParams": {
            "description": "(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.",
            "properties": {},
            "type": "object"
          },
          "authType": {
            "description": "(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.",
            "enum": [
              "API_KEY",
              "BASIC",
              "OAUTH2",
              "MTLS",
              "AD_OAUTH2_CERT"
            ],
            "type": "string"
          },
          "authenticationMethods": {
            "description": "A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.",
            "items": {
              "$ref": "#/components/schemas/WebhookAuthenticationMethod"
            },
            "type": "array"
          },
          "configName": {
            "description": "A unique name used to identify the push configuration.",
            "type": "string"
          },
          "id": {
            "description": "A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.",
            "format": "int64",
            "type": "integer"
          },
          "method": {
            "description": "The HTTP method associated with the webhook endpoint. If not provided, will default to POST.",
            "enum": [
              "GET",
              "POST",
              "PUT",
              "PATCH"
            ],
            "type": "string"
          },
          "methodHeaders": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "A map of optional headers to pass to the webhook.",
            "type": "object"
          },
          "methodParams": {
            "description": "A map of optional method parameters. If provided, these will appear as query parameters on the URL.",
            "properties": {},
            "type": "object"
          },
          "payloadFormat": {
            "description": "The format of the payload to send to the webhook. JSON is the only format supported.",
            "enum": [
              "JSON"
            ],
            "type": "string"
          },
          "url": {
            "description": "The URL of the webhook endpoint.",
            "type": "string"
          },
          "version": {
            "description": "An optional version of the push configuration.",
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "WebhookEndpointCollection": {
        "properties": {
          "webhookEndpoints": {
            "description": "A list of webhook endpoints.",
            "items": {
              "$ref": "#/components/schemas/WebhookEndpoint"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "Weight": {
        "properties": {
          "weight": {
            "description": "The numeric decimal value of this weight.",
            "type": "number"
          },
          "weightUnit": {
            "description": "The unit of measurement for this weight.",
            "enum": [
              "LB",
              "KG"
            ],
            "type": "string"
          }
        },
        "title": "Weight",
        "type": "object"
      },
      "WeightMeasurement": {
        "type": "object",
        "properties": {
          "unit": {
            "$ref": "#/components/schemas/WeightUnit"
          },
          "value": {
            "type": "number",
            "description": "Numeric value of a measurement"
          }
        },
        "description": "A measure of weight with a value and unit"
      },
      "WeightPerDistanceMeasurement": {
        "type": "object",
        "properties": {
          "unit": {
            "$ref": "#/components/schemas/WeightPerDistanceUnit"
          },
          "value": {
            "type": "number",
            "description": "Numeric value of a measurement"
          }
        },
        "description": "A measure of weight per distance with a value and unit"
      },
      "WeightPerDistanceUnit": {
        "type": "string",
        "description": "Weight per distance measurement units (linear density)",
        "format": "enum",
        "enum": [
          "KG_PER_KM"
        ]
      },
      "WeightUnit": {
        "type": "string",
        "description": "Weight measurement units (default: 'LB').",
        "format": "enum",
        "default": "LB",
        "enum": [
          "LB",
          "KG"
        ]
      },
      "WhiteGloveAccessorial": {
        "required": [],
        "type": "object",
        "properties": {
          "code": {
            "enum": [
              "WHITE_GLOVE"
            ],
            "type": "string"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecificationKind_bool_"
              }
            ],
            "description": "Flag denoting requirement."
          }
        },
        "additionalProperties": false,
        "description": "Accessorial which flags the explicit need for white glove service."
      },
      "YardShipment": {
        "type": "object",
        "properties": {
          "carrier": {
            "type": "string",
            "description": "Name of the carrier",
            "example": "ABC Trucking"
          },
          "cabNo": {
            "type": "string",
            "description": "Cab number",
            "example": "CAB789"
          },
          "customer": {
            "type": "string",
            "description": "Customer name",
            "example": "Customer Inc"
          },
          "comment": {
            "type": "string",
            "description": "Additional comments",
            "example": "Handle with care"
          },
          "commodity": {
            "type": "string",
            "description": "Type of commodity",
            "example": "Electronics"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the shipment",
            "example": "shipment_123"
          },
          "loadType": {
            "type": "string",
            "enum": [
              "live",
              "drop"
            ],
            "description": "Type of load",
            "example": "live"
          },
          "licensePlateNo": {
            "type": "string",
            "description": "License plate number",
            "example": "ABC123"
          },
          "loadInformation": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LoadInformation"
            }
          },
          "orderIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of order IDs",
            "example": [
              "ORD001",
              "ORD002"
            ]
          },
          "pallets": {
            "type": "integer",
            "description": "Number of pallets",
            "example": 25
          },
          "reference1": {
            "type": "string",
            "description": "Primary reference number",
            "example": "SHIP123456"
          },
          "reference2": {
            "type": "string",
            "description": "Secondary reference number",
            "example": "REF789"
          },
          "serviceType": {
            "type": "string",
            "enum": [
              "pickup",
              "delivery"
            ],
            "description": "Type of service",
            "example": "delivery"
          },
          "status": {
            "type": "string",
            "description": "Current status of the shipment",
            "example": "SCHEDULED"
          },
          "trailer": {
            "type": "string",
            "description": "Trailer number",
            "example": "TRL123456"
          },
          "units": {
            "type": "integer",
            "description": "Number of units",
            "example": 50
          },
          "vendor": {
            "type": "string",
            "description": "Vendor name",
            "example": "Vendor Corp"
          },
          "weight": {
            "type": "integer",
            "description": "Weight in pounds",
            "example": 5000
          }
        }
      },
      "YmsLocation": {
        "type": "object",
        "properties": {
          "identifier": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "External identifiers for the site",
            "example": [
              "EXT001",
              "EXT002"
            ]
          },
          "siteCode": {
            "type": "string",
            "description": "Code identifying the site",
            "example": "SITE001"
          },
          "siteName": {
            "type": "string",
            "description": "Human-readable name of the site",
            "example": "Main Distribution Center"
          }
        }
      },
      "ZonedDateTimeWindow": {
        "description": "A date and time range, including a time zone, representing a window of availability.",
        "properties": {
          "endDateTime": {
            "description": "End date and time of this window in the applicable time zone. (format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          },
          "localTimeZoneIdentifier": {
            "description": "The time zone identifier (e.g., 'America/Chicago') for this date time window.",
            "type": "string"
          },
          "startDateTime": {
            "description": "Start date and time of this window in the applicable time zone.(default: current date, format: yyyy-MM-dd'T'HH:mm:ss)",
            "format": "date-time",
            "type": "string"
          }
        },
        "title": "ZonedDateTimeWindow",
        "type": "object"
      },
      "Page_InventoryOrder_": {
        "description": "A paginated response containing results and information about the current page.",
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/PaginationInfo"
          },
          "results": {
            "description": "List of resources contained on this page.",
            "items": {
              "$ref": "#/components/schemas/InventoryOrder"
            },
            "type": "array"
          }
        },
        "title": "Page«InventoryOrder»",
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "scheme": "basic",
        "type": "http"
      },
      "oAuth2": {
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v4/oauth2/token",
            "scopes": {}
          }
        },
        "type": "oauth2",
        "description": "Allows generation of a token to access project44 APIs. The tokenUrl base URI may vary based on the tenant region (NA, EU, Sandbox) you are trying to access."
      }
    },
    "parameters": {
      "X-Tenant-Id": {
        "name": "X-Tenant-Id",
        "in": "header",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "X-Tenant-Uuid": {
        "name": "X-Tenant-Uuid",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      },
      "X-User-Id": {
        "name": "X-User-Id",
        "in": "header",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "X-Access-Group-Ids": {
        "name": "X-Access-Group-Ids",
        "in": "header",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "X-Full-Data-Access": {
        "name": "X-Full-Data-Access",
        "in": "header",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "X-Permissions": {
        "name": "X-Permissions",
        "in": "header",
        "required": false,
        "schema": {
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Permission"
          }
        }
      },
      "X-Tenant-Purpose": {
        "name": "X-Tenant-Purpose",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string"
        }
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "OAuth 2.0",
      "tags": [
        "OAuth 2.0: Client Applications",
        "OAuth 2.0: Token Generation"
      ]
    },
    {
      "name": "Unified Shipment Tracking",
      "tags": [
        "Shipment: Tracking"
      ]
    },
    {
      "name": "Shipment Search",
      "tags": [
        "Shipment Search",
        "Filter Suggestions"
      ]
    },
    {
      "name": "Shipment Attributes",
      "tags": [
        "Shipment Attributes"
      ]
    },
    {
      "name": "Shipment Orders and Loads",
      "tags": [
        "Shipment: Loads",
        "Order Visibility"
      ]
    },
    {
      "name": "LTL - Shipping Services",
      "tags": [
        "LTL: Quotes",
        "LTL: Dispatch",
        "LTL: Image Retrieval",
        "LTL: Electronic BOL",
        "LTL: Address Book"
      ]
    },
    {
      "name": "Volume LTL",
      "tags": [
        "VLTL: Quotes",
        "VLTL: Dispatch"
      ]
    },
    {
      "name": "TL - Connected Capacity & Vehicles",
      "tags": [
        "TL: Available Vehicles",
        "TL: Connected Capacity"
      ]
    },
    {
      "name": "Rail - Asset Enrollment",
      "tags": [
        "Asset Tracking"
      ]
    },
    {
      "name": "Multi-Modal",
      "tags": [
        "Multi-Modal: Image Retrieval",
        "Multi-Modal: Rating",
        "Multi-Modal: Booking",
        "Multi-Modal: Packaging",
        "Multi-Modal: Document"
      ]
    },
    {
      "name": "Webhooks",
      "tags": [
        "Webhook",
        "Shipment Webhook Data",
        "Inventory Order and Load Webhook Data"
      ]
    },
    {
      "name": "Capacity Provider Metadata",
      "tags": [
        "Capacity Provider Metadata"
      ]
    },
    {
      "name": "Capacity Provider Accounts",
      "tags": [
        "Capacity Provider Contact Management",
        "Capacity Provider Account Management",
        "Capacity Provider Account Group Management"
      ]
    },
    {
      "name": "LTL Capacity Provider Push",
      "tags": [
        "LTL: Push Tracking",
        "LTL: Push Imaging"
      ]
    },
    {
      "name": "TL Capacity Provider Push",
      "tags": [
        "TL: Capacity Provider Push"
      ]
    },
    {
      "name": "Parcel Capacity Provider Push",
      "tags": [
        "Parcel: Push Tracking"
      ]
    },
    {
      "name": "Tracking Provider Push",
      "tags": [
        "Push Updates"
      ]
    },
    {
      "name": "Analytics",
      "tags": [
        "Analytics: Port Intelligence"
      ]
    },
    {
      "name": "Address",
      "tags": [
        "Stop Location Management",
        "Postal Address Validation"
      ]
    },
    {
      "name": "YMS Appointments",
      "tags": [
        "Appointments",
        "Capacity",
        "Milestones",
        "Reason Codes",
        "Site Codes",
        "Slots"
      ]
    },
    {
      "name": "Network Invitations",
      "tags": [
        "Invitations"
      ]
    },
    {
      "name": "LTL (Legacy ⚠️)",
      "tags": [
        "LTL: Tracking"
      ]
    },
    {
      "name": "TL (Legacy ⚠️)",
      "tags": [
        "TL: Tracking",
        "TL: Webhook"
      ]
    },
    {
      "name": "Parcel (Legacy ⚠️)",
      "tags": [
        "Parcel: Tracking",
        "Parcel: Webhook"
      ]
    },
    {
      "name": "Rail (Legacy ⚠️)",
      "tags": [
        "Rail: Tracking"
      ]
    },
    {
      "name": "Ocean (Legacy ⚠️)",
      "tags": [
        "Ocean: Tracking"
      ]
    }
  ]
}