--- updatedAt: 2025-09-10T21:00:14.000Z agentTools: projectIndex: https://shipcars.readme.io/llms.txt --- # /negotiations/{id}/ Retrieves an identified negotiation thread for a loadboard posting. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "CTMS", "description": "Ship.Cars CTMS", "contact": { "url": "https://ship.cars", "email": "support@ship.cars" }, "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token", "scopes": {} } } } } }, "servers": [ { "url": "https://ship.cars/api" } ], "paths": { "/negotiations/{id}/": { "get": { "tags": [ "Negotiations" ], "description": "Retrieves an identified negotiation thread for a loadboard posting.", "operationId": "negotiations_read", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authenticates API requests with a valid access token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Unique ID of the negotiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "carrier", "last_offer", "shipper" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL of the negotiation resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the negotiation.", "readOnly": true }, "offers": { "type": "array", "description": "List of offers in the negotiation thread.", "readOnly": true, "items": { "required": [ "company", "offer" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL of the offer resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the offer.", "readOnly": true }, "offer": { "required": [ "delivery_date", "pickup_date", "price" ], "type": "object", "properties": { "pickup_date": { "type": "string", "description": "Estimated pickup date.", "format": "date" }, "delivery_date": { "type": "string", "description": "Estimated delivery date.", "format": "date" }, "price": { "type": "string", "description": "Proposed total payment amount for the carrier.", "format": "decimal" } }, "description": "Details of the negotiation offer." }, "status": { "maxLength": 64, "type": "string", "description": "Current status of the offer.", "readOnly": true, "enum": [ "active", "inactive" ] }, "expiration_time": { "type": "string", "description": "Date and time of the offer expiration.", "format": "date-time", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the original creation of the offer.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the offer.", "format": "date-time", "readOnly": true }, "negotiation": { "type": "string", "description": "URL of the resource for the negotiation thread that contains the offer.", "format": "uri", "readOnly": true }, "company": { "type": "string", "description": "URL of the resource for the company that makes the offer.", "format": "uri", "readOnly": true }, "negotiation_id": { "type": "string", "description": "ID of the negotiation thread that contains the offer.", "readOnly": true }, "company_id": { "type": "string", "description": "ID of the company that makes the offer.", "readOnly": true } }, "description": "List of offers in the negotiation thread." } }, "last_offer": { "type": "object", "properties": { "schema": { "required": [ "company", "offer" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL of the offer resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the offer.", "readOnly": true }, "offer": { "required": [ "delivery_date", "pickup_date", "price" ], "type": "object", "properties": { "pickup_date": { "type": "string", "description": "Estimated pickup date.", "format": "date" }, "delivery_date": { "type": "string", "description": "Estimated delivery date.", "format": "date" }, "price": { "type": "string", "description": "Proposed total payment amount for the carrier.", "format": "decimal" } }, "description": "Details of the negotiation offer." }, "status": { "maxLength": 64, "type": "string", "description": "Current status of the offer.", "readOnly": true, "enum": [ "active", "inactive" ] }, "expiration_time": { "type": "string", "description": "Date and time of the offer expiration.", "format": "date-time", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the original creation of the offer.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the offer.", "format": "date-time", "readOnly": true }, "negotiation": { "type": "string", "description": "URL of the resource for the negotiation thread that contains the offer.", "format": "uri", "readOnly": true }, "company": { "type": "string", "description": "URL of the resource for the company that makes the offer.", "format": "uri", "readOnly": true }, "negotiation_id": { "type": "string", "description": "ID of the negotiation thread that contains the offer.", "readOnly": true }, "company_id": { "type": "string", "description": "ID of the company that makes the offer.", "readOnly": true } }, "description": "List of offers in the negotiation thread." } }, "description": "Details of the latest offer in the negotiation thread.", "readOnly": true }, "status": { "maxLength": 64, "type": "string", "description": "Current status of the negotiation.", "readOnly": true, "enum": [ "active", "cancelled", "expired", "archived" ] }, "original_price": { "type": "string", "description": "Carrier payment amount from the original loadboard posting.", "format": "decimal", "readOnly": true }, "is_book_attempt": { "type": "boolean", "description": "Indicates whether the latest carrier offer is a booking attempt.", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the start of the negotiation thread.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the negotiation thread.", "format": "date-time", "readOnly": true }, "order": { "type": "string", "description": "URL of the resource for the load to which the negotiation applies.", "format": "uri", "readOnly": true }, "carrier": { "type": "string", "description": "URL of the resource for the carrier company that negotiates for the load.", "format": "uri", "readOnly": true }, "shipper": { "type": "string", "description": "URL of the resource for the shipper company that posted the load.", "format": "uri", "readOnly": true }, "last_offer_id": { "type": "string", "description": "ID of the resource for the latest offer.", "readOnly": true }, "order_id": { "type": "string", "description": "ID of the load to which the negotiation applies.", "readOnly": true }, "carrier_id": { "type": "string", "description": "ID of the carrier company that negotiates for the load.", "readOnly": true }, "shipper_id": { "type": "string", "description": "ID of the shipper company that posted the load.", "readOnly": true } } }, "example": { "shipper_id": "j4y0", "carrier_id": "jwkx", "order_id": "kew89", "last_offer_id": "nx2e", "shipper": "https://ship.cars/api/companies/j4y0/", "carrier": "https://ship.cars/api/companies/jwkx/", "order": "https://ship.cars/api/loads/kew89/", "update_time": "2018-05-07T21:28:44.724Z", "create_time": "2018-05-07T21:26:55.208Z", "is_book_attempt": false, "original_price": "600.00", "status": "archived", "last_offer": { "company_id": "j4y0", "negotiation_id": "d4vv", "company": "https://ship.cars/api/companies/j4y0/", "negotiation": "https://ship.cars/api/negotiations/d4vv/", "update_time": "2018-05-07T21:28:44.427Z", "create_time": "2018-05-07T21:28:44.427Z", "force_driver_assignment": false, "status": "active", "offer": { "delivery_date": "2018-05-26T00:00:00.000Z", "pickup_date": "2018-05-22T00:00:00.000Z", "price": "650.00" }, "id": "nx2e", "url": "https://ship.cars/api/offers/nx2e/" }, "offers": [ { "company_id": "j4y0", "negotiation_id": "d4vv", "company": "https://ship.cars/api/companies/j4y0/", "negotiation": "https://ship.cars/api/negotiations/d4vv/", "update_time": "2018-05-07T21:28:44.427Z", "create_time": "2018-05-07T21:28:44.427Z", "force_driver_assignment": false, "status": "active", "offer": { "delivery_date": "2018-05-26T00:00:00.000Z", "pickup_date": "2018-05-22T00:00:00.000Z", "price": "650.00" }, "id": "nx2e", "url": "https://ship.cars/api/offers/nx2e/" }, { "company_id": "jwkx", "negotiation_id": "d4vv", "company": "https://ship.cars/api/companies/jwkx/", "negotiation": "https://ship.cars/api/negotiations/d4vv/", "update_time": "2018-05-07T21:28:44.512Z", "create_time": "2018-05-07T21:26:55.643Z", "force_driver_assignment": false, "status": "inactive", "offer": { "delivery_date": "2018-05-26T00:00:00.000Z", "pickup_date": "2018-05-22T00:00:00.000Z", "price": "700.00" }, "id": "y0y6", "url": "https://ship.cars/api/offers/y0y6/" } ], "id": "d4vv", "url": "https://ship.cars/api/negotiations/d4vv/" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Message giving details about the reason for the error response." } } }, "example": { "detail": "Authentication credentials were not provided." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Message giving details about the reason for the error response." } } }, "example": { "detail": "Not found." } } } } }, "x-code-samples": [ { "lang": "cURL", "source": "curl --request GET \\\n--url 'https://ship.cars/api/negotiations/d4vv/' \\\n--header 'Authorization: Bearer <>'\n" } ], "security": [ { "bearerAuth": [] } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```