> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Accept tender > Accept an inbound tender by tender ID, converting it into a booked load in Alvys with the customer, rate, stops, and equipment from the offer. # OpenAPI definition ```json theme={null} { "openapi": "3.0.1", "info": { "title": "Alvys", "description": "Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests.", "contact": { "name": "Alvys Support", "url": "https://www.alvys.com/resources/contact/" }, "version": "v1" }, "servers": [ { "url": "https://integrations.alvys.com", "description": "Public API Server" }, { "url": "https://api.alvys.com/", "description": "Public API Server" } ], "paths": { "/api/p/v{version}/tenders/{tenderId}/accept": { "post": { "tags": [ "Tenders" ], "parameters": [ { "name": "tenderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "API version (e.g., 1.0)", "required": true, "schema": { "type": "string", "default": "1.0", "example": "1.0" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "summary": "Accept tender", "security": [ { "Public": [] } ] } } }, "components": { "schemas": { "Alvys.Models.Tenders.Request.AcceptTenderRequest": { "required": [ "StopCompanyLinks" ], "type": "object", "properties": { "StopCompanyLinks": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Request.StopCompanyLink" } }, "FleetId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Request.StopCompanyLink": { "required": [ "CompanyId", "StopId" ], "type": "object", "properties": { "StopId": { "type": "string" }, "CompanyId": { "type": "string" } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderDateTimeResponse": { "required": [ "DateTime" ], "type": "object", "properties": { "DateTime": { "type": "string", "format": "date-time" }, "TimeZoneCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderEntityResponse": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "CompanyName": { "type": "string", "nullable": true }, "IdCodeQualifier": { "type": "string", "nullable": true }, "IdCode": { "type": "string", "nullable": true }, "N1Qualifier": { "type": "string", "nullable": true }, "Street": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "CountryCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "State": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderEquipmentResponse": { "type": "object", "properties": { "Number": { "type": "string", "nullable": true }, "Length": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderOrderDetailResponse": { "type": "object", "properties": { "Quantity": { "type": "string", "nullable": true }, "WeightUnitCode": { "type": "string", "nullable": true }, "Weight": { "type": "string", "nullable": true }, "ReferenceId": { "type": "string", "nullable": true }, "PoNumber": { "type": "string", "nullable": true }, "VolumeUnitQualifier": { "type": "string", "nullable": true }, "Volume": { "type": "string", "nullable": true }, "UnitBasisForMeasurement": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "ReferenceId2": { "type": "string", "nullable": true }, "SequenceNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderReferenceResponse": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Qualifier": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderResponse": { "required": [ "CompanyCode", "Id", "Status" ], "type": "object", "properties": { "Id": { "type": "string" }, "CompanyCode": { "type": "string" }, "Status": { "type": "string" }, "DateImported": { "type": "string", "format": "date-time", "nullable": true }, "ShipmentId": { "type": "string", "nullable": true }, "LoadNumber": { "type": "string", "nullable": true }, "Equipment": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderEquipmentResponse" } ], "nullable": true }, "Entities": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderEntityResponse" }, "nullable": true }, "PaymentMethod": { "type": "string", "nullable": true }, "QtyPallets": { "type": "string", "nullable": true }, "SCAC": { "type": "string", "nullable": true }, "Weight": { "type": "string", "nullable": true }, "WeightUnitCode": { "type": "string", "nullable": true }, "Volume": { "type": "string", "nullable": true }, "VolumeUnitCode": { "type": "string", "nullable": true }, "Rate": { "type": "string", "nullable": true }, "ExpirationDate": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse" } ], "nullable": true }, "Notes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Stops": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderStopResponse" }, "nullable": true }, "References": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderReferenceResponse" }, "nullable": true }, "RoutingSequenceCode": { "type": "string", "nullable": true }, "TransportationMethodTypeCode": { "type": "string", "nullable": true }, "Etag": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Alvys.Models.Tenders.Response.TenderStopResponse": { "required": [ "StopId", "Type" ], "type": "object", "properties": { "StopId": { "type": "string" }, "Type": { "type": "string" }, "Entity": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderEntityResponse" } ], "nullable": true }, "SequenceNumber": { "type": "string", "nullable": true }, "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderOrderDetailResponse" }, "nullable": true }, "References": { "type": "array", "items": { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderReferenceResponse" }, "nullable": true }, "WeightQualifier": { "type": "string", "nullable": true }, "ArrivedAt": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse" } ], "nullable": true }, "DepartedAt": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse" } ], "nullable": true }, "ScheduledArrivalStart": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse" } ], "nullable": true }, "ScheduledArrivalEnd": { "allOf": [ { "$ref": "#/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse" } ], "nullable": true }, "StopReasonCode": { "type": "string", "nullable": true }, "Notes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Detail": { "type": "string", "nullable": true }, "Instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "Microsoft.AspNetCore.Mvc.ValidationProblemDetails": { "required": [ "Errors" ], "type": "object", "properties": { "Errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Type": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Detail": { "type": "string", "nullable": true }, "Instance": { "type": "string", "nullable": true } }, "additionalProperties": {} } }, "securitySchemes": { "Public": { "type": "apiKey", "description": "JWT token needed to access the endpoints. (eg.) Bearer: ", "name": "Authorization", "in": "header" } } } } ``` ## OpenAPI ````yaml POST /api/p/v{version}/tenders/{tenderId}/accept openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/tenders/{tenderId}/accept: post: tags: - Tenders summary: Accept tender parameters: - name: tenderId in: path required: true schema: type: string - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json-patch+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest application/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest text/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest application/*+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Request.AcceptTenderRequest required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderResponse '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Tenders.Request.AcceptTenderRequest: required: - StopCompanyLinks type: object properties: StopCompanyLinks: type: array items: $ref: '#/components/schemas/Alvys.Models.Tenders.Request.StopCompanyLink' FleetId: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderResponse: required: - CompanyCode - Id - Status type: object properties: Id: type: string CompanyCode: type: string Status: type: string DateImported: type: string format: date-time nullable: true ShipmentId: type: string nullable: true LoadNumber: type: string nullable: true Equipment: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderEquipmentResponse nullable: true Entities: type: array items: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderEntityResponse nullable: true PaymentMethod: type: string nullable: true QtyPallets: type: string nullable: true SCAC: type: string nullable: true Weight: type: string nullable: true WeightUnitCode: type: string nullable: true Volume: type: string nullable: true VolumeUnitCode: type: string nullable: true Rate: type: string nullable: true ExpirationDate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse nullable: true Notes: type: array items: type: string nullable: true Stops: type: array items: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderStopResponse nullable: true References: type: array items: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderReferenceResponse nullable: true RoutingSequenceCode: type: string nullable: true TransportationMethodTypeCode: type: string nullable: true Etag: type: string nullable: true PoNumber: type: string nullable: true additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Models.Tenders.Request.StopCompanyLink: required: - CompanyId - StopId type: object properties: StopId: type: string CompanyId: type: string additionalProperties: false Alvys.Models.Tenders.Response.TenderEquipmentResponse: type: object properties: Number: type: string nullable: true Length: type: string nullable: true Type: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderEntityResponse: type: object properties: Type: type: string nullable: true Name: type: string nullable: true CompanyName: type: string nullable: true IdCodeQualifier: type: string nullable: true IdCode: type: string nullable: true N1Qualifier: type: string nullable: true Street: type: string nullable: true City: type: string nullable: true PostalCode: type: string nullable: true CountryCode: type: string nullable: true Phone: type: string nullable: true Email: type: string nullable: true State: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderDateTimeResponse: required: - DateTime type: object properties: DateTime: type: string format: date-time TimeZoneCode: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderStopResponse: required: - StopId - Type type: object properties: StopId: type: string Type: type: string Entity: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderEntityResponse nullable: true SequenceNumber: type: string nullable: true Orders: type: array items: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderOrderDetailResponse nullable: true References: type: array items: $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderReferenceResponse nullable: true WeightQualifier: type: string nullable: true ArrivedAt: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse nullable: true DepartedAt: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse nullable: true ScheduledArrivalStart: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse nullable: true ScheduledArrivalEnd: allOf: - $ref: >- #/components/schemas/Alvys.Models.Tenders.Response.TenderDateTimeResponse nullable: true StopReasonCode: type: string nullable: true Notes: type: array items: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderReferenceResponse: type: object properties: Id: type: string nullable: true Qualifier: type: string nullable: true Description: type: string nullable: true Type: type: string nullable: true additionalProperties: false Alvys.Models.Tenders.Response.TenderOrderDetailResponse: type: object properties: Quantity: type: string nullable: true WeightUnitCode: type: string nullable: true Weight: type: string nullable: true ReferenceId: type: string nullable: true PoNumber: type: string nullable: true VolumeUnitQualifier: type: string nullable: true Volume: type: string nullable: true UnitBasisForMeasurement: type: string nullable: true Description: type: string nullable: true ReferenceId2: type: string nullable: true SequenceNumber: type: string nullable: true additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````