Shipments / Request Transfer Verification
- Chine Anikwe
Name | Shipments / Request Transfer Verification |
|---|---|
Description | A TOL seller sends a request for transfer verification of an order's shipment |
Type | POST |
URL | /v9/shipments/:id/transfer_verifications/request |
API|User |
Long Description
Request transfer verification on a shipment when you are the top order link seller (on a buy/sell) or the top order link buyer (on a buy) and the shipment is delivered/complete
Request Parameters
None
Response
Name | Body | Description | Code |
Successful transfer verification request | Transfer Verification object | Received after successful creation and notification of a transfer verification request | 201 |
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, shipment does not exist for the calling credential, or the calling credential is not the TOL seller) | 404 |
unauthorized | Requesting brokerage must be the direct buyer | Encountered when the calling credential is associated with the order but is not the TOL or MOL buyer) | 422 |
incorrect_delivery_state | Transfer Verification cannot be requested before a shipment is marked as delivered | Only shipments that are delivered can have transfer verification requested | 422 |
duplicate_request | Transfer Verification was already requested on "DD/MM/YYYY HH:MM". | A request for transfer verification can only happen once per shipment/order. | 422 |
unneeded_request | Transfer Verification has already been uploaded for this shipment | If a TOL seller uploads transfer verification for a shipment (even before a request is made), the BOL seller cannot make another request | 422 |
incorrect_order_type | Cannot request transfer verification for a Purchase Order or a Sell | We're only supporting transfer verification requests and uploads for buy, sell, or buy/sell orders | 422 |
internal_server | Error encountered performing request. Please try again later. | Any internal server error preventing the system from storing the request or notifying the seller. | 500 |
Examples
Request | Response |
|---|---|
POST /v9/shipments/12345/transfer_verifications | Success {
"transfer_verification": {
"id": 12345,
"type": "Proof of Transfer",
"uploads": [],
"created_at": "<iso8601-datetime-string>",
"updated_at": "<iso8601-datetime-string>"
}
}Error {
"errors": [{
"code": "not_found",
"message": "Couldn't find shipment with 'id'=1234"
}]
} |