Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
idapi_docs_shipments


NameShipments Upload Airbill
DescriptionUploads an airbill for shipment
TypePOST
URL/v9/shipments/:id/upload_airbill


Long Description

Uploads an airbill for this shipment in PDF form, as a Base64-encoded file. The response from a successful upload will include url to the airbill.

Parameters

Name
Description
Value Type
Required
fileBase46-encoded PDFstring

Required

tracking_numberTracking number of shipmentstringRequired
carrier

Supported carriers:

  • 'fedex'
  • 'ups'
  • 'usps'
  • 'dhl'
  • 'other'
stringRequired

 

Examples

RequestResponse
/v9/shipments/1234/upload_airbill 


Code Block
languageruby
themeConfluence
{
	"file": "<Base64-encoded file>",
	"tracking_number": "54321",
	"carrier": "fedex"
}


 

See Shipments / Show