Shipments / Retrieve Transfer Verifications
- Chine Anikwe
Analytics
Name | Shipments / Transfer Verification |
|---|---|
Description | A TOL seller sends a request for transfer verification of an order's shipment |
Type | GET |
URL | /v9/shipments/:id/transfer_verifications |
API|User |
Long Description
Retrieve all transfer verification documents on a shipment when you are the middle order link buyer (on a buy/sell), top order link buyer (on a buy), or the bottom order link seller and the shipment is delivered/complete
Note: when no transfer verifications have been uploaded, this will return an empty array
Response
Name | Body | Description | Code |
Transfer verifications | List of transfer verifications | A transfer verification with an empty array of associated upload files indicates that request was made and not yet fulfilled. A transfer verification with associated upload files indicates that the seller uploaded the transfer verification without a request or that a previously submitted request was fulfilled | 200 |
Errors
Name | Message | Description | Code |
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 |
internal_server | Error encountered retrieving transfer verification | Any internal server error preventing the system from storing the transfer verification | 500 |
Examples
Request | Response |
|---|---|
GET /v9/shipments/12345/transfer_verifications | Success {
"transfer_verifications": [
{
"id": 12345,
"type": "Proof of Transfer",
"uploads": [{
"file_name": "image.png",
"url": "<link-to-downloadable-url>"
}],
"created_at": "<iso8601-datetime-string>",
"updated_at": "<iso8601-datetime-string>"
}
]
}Error {
"errors": [{
"code": "not_found",
"message": "Shipment with 'id'=12345 was not found"
}]
} |