Generate a rate confirmation for a shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

Responses

200

Successfully generated rate confirmation

Response Schema: application/json

created_at

string or null <date-time>

created_by_id

string or null <uuid>

created_by_name

string or null

description

string or null

file

string or null

URL to file. URLs have timed access tokens and expire in 10 minutes.

filename

string or null

Filename of file

string or null <uuid>

updated_at

string or null <date-time>

company

string or null

driver

string or null <uuid>

Id of the driver who created the document, if one exists

is_carrier_document

boolean

shipment

string or null <uuid>

type

string or null

Enum Value	Description
ADVANCE_REQUEST	Advance Request
AUTHORITY	Authority
BOL	Bill of Lading (BOL)
CARRIER_INVOICE_OR_BILLING_STATEMENT	Carrier Invoice or Billing Statement
CERTIFICATE_OF_ANALYSIS	Certificate of Analysis
CERTIFICATE_OF_ORIGIN	Certificate of Origin
CLAIM	Claim
COMCHECK	Comcheck
COMMERCIAL_INVOICE	Commercial Invoice
CUSTOMER_INVOICE	Customer Invoice
CUSTOMER_TENDER	Customer Tender
CUSTOMS_CLEARANCE_REQUEST	Customs Clearance Request
CUSTOMS_ENTRY_SUMMARY	Customs Entry Summary
CUSTOMS_PAPERWORK	Customs Paperwork
DELIVERY_ORDER	Delivery Order
DELIVERY_RECEIPT	Proof of Delivery (POD)
DETENTION_APPROVAL	Detention Approval
DRIVER_FORM	Driver Form
EXIT_PASS	Exit Pass
FACTOR_INVOICE_OR_BILLING_STATEMENT	Factor Invoice or Billing Statement
FINE	Fine
FUEL	Fuel Receipt
HOS	Hours of Service Log
HOUSE_AIRWAY_BILL	House Airway Bill
HOUSE_BILL_OF_LADING	House Bill of Lading
INSPECTION_CERTIFICATE	Inspection Certificate
INSURANCE	Insurance
INVENTORY_RELEASE	Inventory Release
INVOICE	Invoice
LETTER_OF_ASSIGNMENT	Letter of Assignment
LUMPER	Lumper Receipt
MASTER_AIRWAY_BILL	Master Airway Bill
MASTER_BILL_OF_LADING	Master Bill of Lading
NMFC_CERTIFICATE	NMFC Certificate
NOTICE_OF_ASSIGNMENT	Notice of Assignment
NOTICE_OF_RELEASE	Notice of Release
OTHER	Other
OVERAGES_SHORTAGES_AND_DAMAGES	Overages, Shortages and Damages
PACKING_SLIP	Packing Slip
PACKING_SLIPS	Packing Slips
PALLET_RECEIPT	Pallet Receipt
RATE_CONFIRMATION	Rate Confirmation
RENDITION_INVOICE_PACKET	Rendition / Invoice Packet
SAFETY_DATA_SHEET	Safety Data Sheet
SHIPPING_LABEL	Shipping Label
SIGNATURE	Signature
TOLL_RECEIPT	Toll Receipt
W9	W9
WASH_RECEIPT	Wash Receipt
WAYBILL	Waybill
WEIGHT_CERTIFICATE	Weight Certificate
WEIGHT_TICKET_UNLOADED	Weight Ticket Unloaded

default

Default error response

get/shipments/{shipmentId}/documents/generate_rate_confirmation/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"created_at": "2019-08-24T14:15:22Z",
"created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
"created_by_name": "string",
"description": "string",
"file": "https://files.example.com/...",
"filename": "Bill_of_Lading.pdf",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"company": "string",
"driver": "ef731cbb-90ac-4a46-9655-0609f31cd17a",
"is_carrier_document": true,
"shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
"type": "string"
}