Returns CSV with requested shipments info, in the same ordering as requested

SecurityAuthToken

Request

Request Body schema: application/json
required

column_names

Array of strings (columnNames)

the name of the column you want to export

Items Enum: "reference_id" "state" "customer_name" "pickup" "pickup_date" "delivery" "delivery_date" "number_of_pickups" "number_of_deliveries" "mode_code" "equipment_type_name" "total_weight_lbs" "created_at" "accessorials" "bol_number" "book_now" "carrier_status" "drayage_container_number" "drayage_container_return_date" "created_by" "customer_financials" "carrier_financials" "customer_reference_number" "delivery_company" "drayage_estimated_arrival_date" "drayage_house_bol_number" "drayage_last_free_date" "load_board_id" "lowest_bid" "markup" "max_buy" "name" "net_financials" "pickup_company" "pickup_number" "purchase_order_number" "pro_number" "provider_financials" "drayage_release_date" "drayage_seal_number" "service_level" "target_rate" "timeline_last_updated_at" "total_miles" "trailer_name" "workflows" "carrier" "multi_stage_id" "stages" "custom_data" "power_unit" "tender_status"

shipment_ids

Array of strings <uuid> (shipmentIds)

The ids of the shipment

Responses

200

Returns CSV with requested shipments info

Response Schema: text/csv

string

default

Default error response

post/shipments/download-csv/

Request samples

application/json

{"column_names": ["reference_id"
],
"shipment_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

default

application/json

{"error": "string",
"error_description": "string",
"field_errors": {"property1": ["string"
],
"property2": ["string"
]
},
"field_errors_condensed": [{"field_errors": ["string"
],
"field_name": "string"
}
],
"non_field_errors": ["string"
]
}