Freightview MCP by usefulapi
Rate, book and cancel LTL, parcel and truckload shipments, and track them in Freightview.
사용해야 할까요
품질 및 안전성
A
발견 사항 (17)
- LOWTool 'freightview_get_account_locations' name length outside 3-30 rangefreightview_get_account_locations에서
- LOWTool 'freightview_get_account_carriers' name length outside 3-30 rangefreightview_get_account_carriers에서
- LOWTool 'freightview_get_shipment_quotes' name length outside 3-30 rangefreightview_get_shipment_quotes에서
- LOWTool 'freightview_get_shipment_tracking' name length outside 3-30 rangefreightview_get_shipment_tracking에서
- LOWTool 'freightview_create_ltl_shipment' name length outside 3-30 rangefreightview_create_ltl_shipment에서
- LOWTool 'freightview_create_parcel_shipment' name length outside 3-30 rangefreightview_create_parcel_shipment에서
- LOWTool 'freightview_create_truckload_shipment' name length outside 3-30 rangefreightview_create_truckload_shipment에서
- LOWTool 'freightview_book_ltl_freight_collect' name length outside 3-30 rangefreightview_book_ltl_freight_collect에서
- LOWTool 'freightview_book_parcel_shipment' name length outside 3-30 rangefreightview_book_parcel_shipment에서
- LOWTool 'freightview_book_parcel_freight_collect' name length outside 3-30 rangefreightview_book_parcel_freight_collect에서
도구 정의와 프로토콜 준수에 대한 자동 분석을 기반으로 합니다.
컨텍스트 비용
~8,133토큰 (도구 정의)
~3.5 KB일반적인 응답 크기
상당한 주의 영향 (128k 컨텍스트의 6.35%)
이는 서버의 도구가 모델의 컨텍스트에 로드될 때마다 소비되는 대략적인 토큰 수입니다. 수치가 높을수록 다른 작업에 사용할 수 있는 주의가 줄어듭니다.
설치
원클릭 설치
`claude_desktop_config.json` 파일에 다음을 추가하세요:
{
"mcpServers": {
"freightview": {
"url": "https://freightview.usefulapi.io/mcp"
}
}
}원격 엔드포인트
https://freightview.usefulapi.io/mcpstreamable-http할 수 있는 일
도구 목록
도구 (22)
🟢 읽기 전용🟡 쓰기🔴 삭제⚪ 알 수 없음
🟢freightview_get_account_users
List the users on the Freightview account behind the API credentials. Freightview API: GET /account/users.
입력 스키마
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_account_locations
List the saved locations (sites) on the Freightview account. Freightview API: GET /account/locations.
입력 스키마
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_account_carriers
List the carriers added to the Freightview account (carrier ids used in quotes). Freightview API: GET /account/carriers.
입력 스키마
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_carrier(scac)
Get a carrier's name and its available services by SCAC code. Freightview API: GET /carriers/{scac}.
입력 스키마
{
"type": "object",
"properties": {
"scac": {
"type": "string",
"minLength": 2,
"maxLength": 8,
"description": "Carrier SCAC code, e.g. FXFE."
}
},
"required": [
"scac"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_search_shipments(continuationToken, search, status, mode, direction, ...)
Search shipments on the account, with filters and a continuation token for the next page. Freightview API: GET /shipments.
입력 스키마
{
"type": "object",
"properties": {
"continuationToken": {
"description": "Token from the previous page's continuationToken.",
"type": "string",
"maxLength": 500
},
"search": {
"description": "Free-text search.",
"type": "string",
"maxLength": 200
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pending",
"awarded",
"confirmed",
"picked-up",
"delivered",
"canceled"
]
}
},
"mode": {
"type": "array",
"items": {
"type": "string",
"enum": [
"truckload",
"parcel",
"ltl",
"intermodal",
"consolidated",
"air",
"ocean",
"bulk"
]
}
},
"direction": {
"type": "string",
"enum": [
"inbound",
"outbound",
"third-party"
]
},
"equipmentType": {
"type": "string",
"maxLength": 60
},
"isArchived": {
"type": "boolean"
},
"pickupDateStart": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"pickupDateEnd": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"deliveryDateStart": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"deliveryDateEnd": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"referenceNumber": {
"type": "string",
"maxLength": 120
},
"bolNumber": {
"type": "string",
"maxLength": 120
},
"trackingNumber": {
"type": "string",
"maxLength": 120
},
"carrier": {
"description": "Carrier name or code, as Freightview accepts it.",
"type": "string",
"maxLength": 120
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_shipment(shipmentId)
Get one shipment: status, locations, items, selected quote, tracking and documents. Freightview API: GET /shipments/{shipmentId}.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
}
},
"required": [
"shipmentId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_shipment_quotes(shipmentId)
List the quotes for a shipment, with quoteId, carrier, amount and expiry. Use quoteId to book. Freightview API: GET /shipments/{shipmentId}/quotes.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
}
},
"required": [
"shipmentId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢freightview_get_shipment_tracking(shipmentId, itemId, itemIndex)
Get the tracking events of a shipment, optionally for one item. Freightview API: GET /shipments/{shipmentId}/tracking.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"itemId": {
"type": "string",
"maxLength": 80
},
"itemIndex": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"shipmentId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_create_ltl_shipment(pickupDate, origin, destination, items, returnQuotes)
Create and rate an LTL shipment draft with quotes. Nothing is booked. Book a quote later with freightview_book_ltl_shipment. Freightview API: POST /shipments/ltl.
입력 스키마
{
"type": "object",
"properties": {
"pickupDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"origin": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca"
]
},
"opensAt": {
"description": "Opening time, e.g. 08:00.",
"type": "string",
"maxLength": 10
},
"closesAt": {
"description": "Closing time, e.g. 17:00.",
"type": "string",
"maxLength": 10
},
"shipType": {
"description": "e.g. business dock, business no dock, residential.",
"type": "string",
"maxLength": 40
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {},
"description": "Pickup (origin) or delivery (destination) place. Other fields pass through to Freightview."
},
"destination": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca"
]
},
"opensAt": {
"description": "Opening time, e.g. 08:00.",
"type": "string",
"maxLength": 10
},
"closesAt": {
"description": "Closing time, e.g. 17:00.",
"type": "string",
"maxLength": 10
},
"shipType": {
"description": "e.g. business dock, business no dock, residential.",
"type": "string",
"maxLength": 40
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {},
"description": "Pickup (origin) or delivery (destination) place. Other fields pass through to Freightview."
},
"items": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Weight in pounds, including the packaging."
},
"type": {
"type": "string",
"enum": [
"bag",
"bale",
"basket",
"box",
"bundle",
"carpet",
"case",
"coil",
"crate",
"cylinder",
"drum",
"jerrican",
"keg",
"pail",
"pallet",
"piece",
"reel",
"roll",
"tote",
"tube",
"unit"
]
},
"description": {
"type": "string",
"maxLength": 200
},
"freightClass": {
"description": "NMFC freight class, e.g. 50, 55, 77.5, 100.",
"type": "number"
},
"length": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"width": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"height": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"stackable": {
"type": "boolean"
},
"isHazardous": {
"type": "boolean"
}
},
"required": [
"quantity",
"weight",
"type"
],
"additionalProperties": {}
}
},
"returnQuotes": {
"description": "Return the quotes in the response.",
"type": "boolean"
}
},
"required": [
"pickupDate",
"origin",
"destination",
"items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_create_parcel_shipment(pickupDate, schedulePickup, origin, destination, items, ...)
Create and rate a parcel shipment draft with quotes. Nothing is booked. Book a quote later with freightview_book_parcel_shipment. Freightview API: POST /shipments/parcel.
입력 스키마
{
"type": "object",
"properties": {
"pickupDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"schedulePickup": {
"type": "boolean"
},
"origin": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"description": "ISO country code, e.g. us or ca."
},
"shipType": {
"type": "string",
"enum": [
"business dock",
"residential"
]
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {}
},
"destination": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"description": "ISO country code, e.g. us or ca."
},
"shipType": {
"type": "string",
"enum": [
"business dock",
"residential"
]
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {}
},
"items": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "\"custom\" for custom packaging, or a packaging type id from Freightview."
},
"description": {
"type": "string",
"maxLength": 200
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Weight in pounds."
},
"length": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"width": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"height": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"type",
"weight"
],
"additionalProperties": {}
}
},
"shareShipmentEmails": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"returnQuotes": {
"description": "Return the quotes in the response.",
"type": "boolean"
}
},
"required": [
"pickupDate",
"origin",
"destination",
"items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_create_truckload_shipment(locations, equipment, isLiveLoad, billTo, bolNumber, ...)
Create a truckload shipment draft with its stops and equipment. Nothing is awarded or booked. Freightview API: POST /shipments/truckload.
입력 스키마
{
"type": "object",
"properties": {
"locations": {
"minItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca",
"mx"
]
},
"stopType": {
"type": "string",
"enum": [
"pickup",
"delivery",
"both"
]
},
"sequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Stop order, starting at 1."
},
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"stopDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"stopDateType": {
"type": "string",
"enum": [
"on",
"by"
]
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country",
"stopType",
"sequence"
],
"additionalProperties": {},
"description": "A pickup or delivery stop. Other fields pass through to Freightview."
}
},
"equipment": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Equipment type, e.g. dry-van-53, flatbed-48, refrigerated-53."
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Total weight in pounds."
},
"weightUOM": {
"type": "string",
"const": "lbs"
},
"isHazardous": {
"type": "boolean"
}
},
"required": [
"type",
"description",
"weight",
"weightUOM",
"isHazardous"
],
"additionalProperties": {}
},
"isLiveLoad": {
"type": "boolean",
"description": "true when the driver waits during loading."
},
"billTo": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"address": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"contactEmail": {
"type": "string",
"minLength": 3,
"maxLength": 160
}
},
"required": [
"company",
"address",
"city",
"state",
"postalCode",
"contactName",
"contactEmail"
],
"additionalProperties": {},
"description": "Bill-to account. Other fields pass through to Freightview."
},
"bolNumber": {
"type": "string",
"maxLength": 60
},
"shareShipmentEmails": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
}
},
"required": [
"locations",
"equipment",
"isLiveLoad"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_book_ltl_shipment(shipmentId, booking, confirm)
BOOKS an LTL shipment with a quote, which commits the account to the carrier and its charge. Call only after the user approves this quote and price. Freightview API: POST /shipments/ltl/{shipmentId}/book.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"booking": {
"type": "object",
"properties": {
"quoteId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "quoteId from freightview_get_shipment_quotes or a create response."
},
"billTo": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"address": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"contactEmail": {
"type": "string",
"minLength": 3,
"maxLength": 160
}
},
"required": [
"company",
"address",
"city",
"state",
"postalCode",
"contactName",
"contactEmail"
],
"additionalProperties": {},
"description": "Bill-to account. Other fields pass through to Freightview."
},
"schedulePickup": {
"type": "boolean"
},
"bolNumber": {
"type": "string",
"maxLength": 60
}
},
"required": [
"quoteId"
],
"additionalProperties": {},
"description": "Booking body. quoteId is required; other fields pass through to Freightview."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"booking",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_book_ltl_freight_collect(pickupDate, origin, destination, items, confirm)
BOOKS a customer-routed (freight collect) LTL shipment. The account's own carrier collects the freight. Call only after the user approves it. Freightview API: POST /shipments/ltl/book/freight-collect.
입력 스키마
{
"type": "object",
"properties": {
"pickupDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"origin": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca"
]
},
"opensAt": {
"description": "Opening time, e.g. 08:00.",
"type": "string",
"maxLength": 10
},
"closesAt": {
"description": "Closing time, e.g. 17:00.",
"type": "string",
"maxLength": 10
},
"shipType": {
"description": "e.g. business dock, business no dock, residential.",
"type": "string",
"maxLength": 40
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {},
"description": "Pickup (origin) or delivery (destination) place. Other fields pass through to Freightview."
},
"destination": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca"
]
},
"opensAt": {
"description": "Opening time, e.g. 08:00.",
"type": "string",
"maxLength": 10
},
"closesAt": {
"description": "Closing time, e.g. 17:00.",
"type": "string",
"maxLength": 10
},
"shipType": {
"description": "e.g. business dock, business no dock, residential.",
"type": "string",
"maxLength": 40
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {},
"description": "Pickup (origin) or delivery (destination) place. Other fields pass through to Freightview."
},
"items": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Weight in pounds, including the packaging."
},
"type": {
"type": "string",
"enum": [
"bag",
"bale",
"basket",
"box",
"bundle",
"carpet",
"case",
"coil",
"crate",
"cylinder",
"drum",
"jerrican",
"keg",
"pail",
"pallet",
"piece",
"reel",
"roll",
"tote",
"tube",
"unit"
]
},
"description": {
"type": "string",
"maxLength": 200
},
"freightClass": {
"description": "NMFC freight class, e.g. 50, 55, 77.5, 100.",
"type": "number"
},
"length": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"width": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"height": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"stackable": {
"type": "boolean"
},
"isHazardous": {
"type": "boolean"
}
},
"required": [
"quantity",
"weight",
"type"
],
"additionalProperties": {}
}
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"pickupDate",
"origin",
"destination",
"items",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_book_parcel_shipment(shipmentId, quoteId, shareShipmentEmails, confirm)
BOOKS a parcel shipment with a quote, which commits the account to the carrier and its charge. Call only after the user approves this quote and price. Freightview API: POST /shipments/parcel/{shipmentId}/book.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"quoteId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "quoteId from freightview_get_shipment_quotes or a create response."
},
"shareShipmentEmails": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"quoteId",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_book_parcel_freight_collect(pickupDate, origin, destination, items, confirm)
BOOKS a customer-routed (freight collect) parcel shipment. Call only after the user approves it. Freightview API: POST /shipments/parcel/book/freight-collect.
입력 스키마
{
"type": "object",
"properties": {
"pickupDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"origin": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"description": "ISO country code, e.g. us or ca."
},
"shipType": {
"type": "string",
"enum": [
"business dock",
"residential"
]
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {}
},
"destination": {
"type": "object",
"properties": {
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"address2": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"description": "ISO country code, e.g. us or ca."
},
"shipType": {
"type": "string",
"enum": [
"business dock",
"residential"
]
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
}
},
"required": [
"postalCode",
"country"
],
"additionalProperties": {}
},
"items": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "\"custom\" for custom packaging, or a packaging type id from Freightview."
},
"description": {
"type": "string",
"maxLength": 200
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Weight in pounds."
},
"length": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"width": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"height": {
"description": "Inches.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"type",
"weight"
],
"additionalProperties": {}
}
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"pickupDate",
"origin",
"destination",
"items",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_cancel_ltl_shipment(shipmentId, confirm)
CANCELS an LTL shipment. Call only after the user approves the cancellation. Freightview API: DELETE /shipments/ltl/{shipmentId}.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_cancel_parcel_shipment(shipmentId, confirm)
CANCELS a parcel shipment. Call only after the user approves the cancellation. Freightview API: DELETE /shipments/parcel/{shipmentId}.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_cancel_truckload_shipment(shipmentId, confirm)
CANCELS a truckload shipment. Call only after the user approves the cancellation. Freightview API: DELETE /shipments/truckload/{shipmentId}.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_award_truckload_shipment(shipmentId, award, confirm)
AWARDS a truckload shipment to the carrier of a quote, which commits the carrier. Call only after the user approves this quote. Freightview API: POST /shipments/truckload/{shipmentId}/award.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"award": {
"type": "object",
"properties": {
"quoteId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "quoteId from freightview_get_shipment_quotes or a create response."
},
"locations": {
"minItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca",
"mx"
]
},
"stopType": {
"type": "string",
"enum": [
"pickup",
"delivery",
"both"
]
},
"sequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Stop order, starting at 1."
},
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"stopDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"stopDateType": {
"type": "string",
"enum": [
"on",
"by"
]
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country",
"stopType",
"sequence"
],
"additionalProperties": {},
"description": "A pickup or delivery stop. Other fields pass through to Freightview."
}
}
},
"required": [
"quoteId",
"locations"
],
"additionalProperties": {},
"description": "Award body. quoteId and locations are required; other fields pass through to Freightview."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"award",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_confirm_truckload_shipment(shipmentId, pickupConfirmationNumber, confirm)
CONFIRMS a truckload shipment with the carrier's pickup confirmation number. Call only after the user approves it. Freightview API: POST /shipments/truckload/{shipmentId}/confirm.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"pickupConfirmationNumber": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"pickupConfirmationNumber",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_retract_truckload_award(shipmentId, notifyCarrier, confirm)
RETRACTS an awarded truckload shipment from its carrier. Call only after the user approves it. Freightview API: POST /shipments/truckload/{shipmentId}/retract.
입력 스키마
{
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Freightview shipment id."
},
"notifyCarrier": {
"type": "boolean",
"description": "true to notify the carrier of the retraction."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"shipmentId",
"notifyCarrier",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴freightview_book_truckload_freight_collect(carrierId, locations, equipment, billTo, items, ...)
BOOKS a customer-routed (freight collect) truckload shipment with a carrier. Call only after the user approves it. Freightview API: POST /shipments/truckload/freight-collect.
입력 스키마
{
"type": "object",
"properties": {
"carrierId": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"locations": {
"minItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"country": {
"type": "string",
"enum": [
"us",
"ca",
"mx"
]
},
"stopType": {
"type": "string",
"enum": [
"pickup",
"delivery",
"both"
]
},
"sequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Stop order, starting at 1."
},
"company": {
"type": "string",
"maxLength": 120
},
"address": {
"type": "string",
"maxLength": 160
},
"city": {
"type": "string",
"maxLength": 80
},
"state": {
"type": "string",
"maxLength": 3
},
"stopDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"stopDateType": {
"type": "string",
"enum": [
"on",
"by"
]
},
"opensAt": {
"type": "string",
"maxLength": 10
},
"closesAt": {
"type": "string",
"maxLength": 10
},
"contactName": {
"type": "string",
"maxLength": 120
},
"contactEmail": {
"type": "string",
"maxLength": 160
},
"contactPhone": {
"type": "string",
"maxLength": 40
},
"instructions": {
"type": "string",
"maxLength": 500
}
},
"required": [
"postalCode",
"country",
"stopType",
"sequence"
],
"additionalProperties": {},
"description": "A pickup or delivery stop. Other fields pass through to Freightview."
}
},
"equipment": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "Equipment type, e.g. dry-van-53, flatbed-48, refrigerated-53."
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"weight": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "Total weight in pounds."
},
"weightUOM": {
"type": "string",
"const": "lbs"
},
"isHazardous": {
"type": "boolean"
}
},
"required": [
"type",
"description",
"weight",
"weightUOM",
"isHazardous"
],
"additionalProperties": {}
},
"billTo": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"address": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 3
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"contactName": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"contactEmail": {
"type": "string",
"minLength": 3,
"maxLength": 160
}
},
"required": [
"company",
"address",
"city",
"state",
"postalCode",
"contactName",
"contactEmail"
],
"additionalProperties": {},
"description": "Bill-to account. Other fields pass through to Freightview."
},
"items": {
"description": "Handling units, passed through to Freightview.",
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"createBOL": {
"type": "boolean"
},
"schedulePickup": {
"type": "boolean"
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user explicitly approved this action now."
}
},
"required": [
"carrierId",
"locations",
"equipment",
"billTo",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}커뮤니티
증거
최근 관측
검증됨버전이 기록되지 않음도구 22개