Shipments / Upload Transfer Verification

Name	Shipments / Upload Transfer Verification
Description	A BOL seller uploads transfer verification for an order's shipment
Type	POST
URL	/v9/shipments/:id/transfer_verifications
Credential Type	API\|User

Long Description

Upload transfer verification on a shipment when you are the bottom order link seller and the shipment’s associated order is accepted or complete. Note, when the transfer_verification_id is included in the request body, the uploaded files will be associated with that transfer verification request

Request Parameters

Name	Description	Type	Presence

Name

Description

Type

Presence

files

List of encoded files

array

required

transfer_verification_id

ID of the transfer verification. This is necessary when fulfilling a transfer verification request. If no id is provided, a new transfer verification object will be created

string

required only when fulfilling a transfer verification request

type

One of the following:

Proof of Transfer (default)
Proof of Acceptance
Proof of Delivery Delay
Primary Correspondence
Other Information

string

optional

Response

Name	Body	Description	Code
Transfer verification create	New Transfer Verification object with uploaded files	Received after successful creation and notification of a new transfer verification upload to the buyer	201
Transfer Verification update	Updated Transfer Verification object with uploaded files	Received after successful fulfillment of an existing Transfer Verification request and notification to the buyer	200

Errors

Name	Message	Description	Code
invalid_params	Varies	Relays issues with the request payload	400
unauthorized	Uploading brokerage must be the direct seller	Encountered when any caller other than the selling brokerage attempts to upload proof of transfer documents	401
not_found	Shipment with id 1234 was not found.	Encountered when the shipment cannot be found for the caller (e.g. shipment does not exist or shipment does not exist for the calling credential)	404
incorrect_order_type	Cannot upload transfer verification for a Purchase Order	We're only supporting transfer verification requests and uploads for buy, sell, or buy/sell orders	422
unsupported_media_type	File type is not supported	Encountered when the caller sends an unsupported file type	415
internal_server	Error encountered uploading transfer verification	Any internal server error preventing the system from storing the transfer verification	500

Examples

Request	Response

Request

Response

POST /v9/shipments/12345/transfer_verifications

{
  "type": "Proof of Transfer",
  "files": [
      "<base-64 encoded file>",
      "<another base-64 encoded file>"
  ]
}

Success

{
    "transfer_verification": {
        "id": 1234,
        "type": "Proof of Transfer",
        "links": [
            "<link-to-downloadable-url>",
            "<link-to-downloadable-url>"
        ],
        "created_at": "DD/MM/YYYY HH:MM",
    }
}

Error

{
    "errors": [
        {
          "code": "not_found",
          "message": "Couldn't find Shipment with 'id'=12345"
        }
    ]
}