Create many shipments at once from a spreadsheet export, checked row by row before anything is created.
Upload a CSV file of shipments
Reads the file (UTF-8, comma or semicolon, header row first, at most 1,000 rows), maps each column from its header or from the mapping saved for the shipper, and checks every row. Nothing is created yet. Allowed to carrier admins and dispatchers, and to shipper users, whose imports are always billed to their account.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Upload a CSV file of shipments › Request Body
file_namecontentThe CSV text, UTF-8, header row first; commas or semicolons.
shipper_account_id^([0-9a-fA-F]{8}-[0-…The account billed; null for counter customers.
Upload a CSV file of shipments › Responses
The import, its columns and its row problems.
idfile_namedelimiterrow_countData rows, header excluded.
created_by_namecreated_at^(?:(?:\d\d[2468][04… · requiredshipper_account_idstatusdraft until shipments are created, creating while some remain, then completed.
ready_countOne entry per problem; a row with errors is skipped unless corrected.
estimated_total_xpfReady rows, TGC included.
created_countShipments created so far.
The shipments created, by file line.
Get an import
Its columns, its row problems and the shipments created so far. Allowed to carrier admins and dispatchers, and to shipper users, whose imports are always billed to their account.
path Parameters
importIdThe import id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get an import › Responses
The import.
idfile_namedelimiterrow_countData rows, header excluded.
created_by_namecreated_at^(?:(?:\d\d[2468][04… · requiredshipper_account_idstatusdraft until shipments are created, creating while some remain, then completed.
ready_countOne entry per problem; a row with errors is skipped unless corrected.
estimated_total_xpfReady rows, TGC included.
created_countShipments created so far.
The shipments created, by file line.
Change the mapping or correct rows
Changes the field of each column, the account billed, or the value of a cell, and checks the rows again. A new mapping is saved as the template of the shipper account. Refused once shipments were created. Allowed to carrier admins and dispatchers, and to shipper users, whose imports are always billed to their account.
path Parameters
importIdThe import id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change the mapping or correct rows › Request Body
mappingThe field of each column, in file order.
shipper_account_id^([0-9a-fA-F]{8}-[0-…Change the mapping or correct rows › Responses
The import, checked again.
idfile_namedelimiterrow_countData rows, header excluded.
created_by_namecreated_at^(?:(?:\d\d[2468][04… · requiredshipper_account_idstatusdraft until shipments are created, creating while some remain, then completed.
ready_countOne entry per problem; a row with errors is skipped unless corrected.
estimated_total_xpfReady rows, TGC included.
created_countShipments created so far.
The shipments created, by file line.
Create the shipments of an import
Creates the shipments of the next 25 ready rows; call again until status is completed. Rows with problems are skipped. Safe to retry: a row never creates two shipments. Allowed to carrier admins and dispatchers, and to shipper users, whose imports are always billed to their account.
path Parameters
importIdThe import id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Create the shipments of an import › Responses
The import, with the shipments created so far.
idfile_namedelimiterrow_countData rows, header excluded.
created_by_namecreated_at^(?:(?:\d\d[2468][04… · requiredshipper_account_idstatusdraft until shipments are created, creating while some remain, then completed.
ready_countOne entry per problem; a row with errors is skipped unless corrected.
estimated_total_xpfReady rows, TGC included.
created_countShipments created so far.
The shipments created, by file line.