> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/api-reference/tracr-api/references/transfer.md).

# Transfer

## Transfer In Reject

> Reject inbound diamonds.\
> \
> Diamonds must not have been ACCEPTED in order to be rejected.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/transfer/in/{shipment_id}/reject":{"post":{"description":"Reject inbound diamonds.\n\nDiamonds must not have been ACCEPTED in order to be rejected.","operationId":"transfer_in_reject_transfer_in__shipment_id__reject_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Data","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferInRejectDiamondResult"},"title":"Response Transfer In Reject Transfer In  Shipment Id  Reject Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Reject","tags":["Transfer","Transfer"]}}},"components":{"schemas":{"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferInRejectDiamondResult":{"description":"Returned by transfer/in/reject for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInRejectStatus"}},"required":["diamond_id","status"],"title":"TransferInRejectDiamondResult","type":"object"},"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer Out Cancel

> Cancel outbound diamonds preventing them from being accepted.\
> \
> User initiated by the sender.\
> \
> Diamonds must not have been ACCEPTED in order to be cancelled.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/transfer/out/{shipment_id}/cancel":{"post":{"description":"Cancel outbound diamonds preventing them from being accepted.\n\nUser initiated by the sender.\n\nDiamonds must not have been ACCEPTED in order to be cancelled.","operationId":"transfer_out_cancel_transfer_out__shipment_id__cancel_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Data","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferOutCancelDiamondResult"},"title":"Response Transfer Out Cancel Transfer Out  Shipment Id  Cancel Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Cancel","tags":["Transfer","Transfer"]}}},"components":{"schemas":{"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferOutCancelDiamondResult":{"description":"Returned by transfer/out/cancel for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferOutCancelStatus"}},"required":["diamond_id","status"],"title":"TransferOutCancelDiamondResult","type":"object"},"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer In Accept

> Accept an inbound shipment of diamonds.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/accept":{"post":{"description":"Accept an inbound shipment of diamonds.","operationId":"transfer_in_accept_v2_transfer_in__shipment_id__accept_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Response"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Accept","tags":["Transfer"]}}},"components":{"schemas":{"TransferInAcceptV2Request":{"description":"A list of diamonds to accept for transfer.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"TransferInAcceptV2Request","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferInAcceptV2Response":{"description":"Aggregated results of accepting diamonds for transfer.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/TransferInAcceptV2DiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"TransferInAcceptV2Response","type":"object"},"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer In Accept All

> Accept all the diamonds in the inbound shipment.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/accept/all":{"post":{"description":"Accept all the diamonds in the inbound shipment.","operationId":"transfer_in_accept_all_v2_transfer_in__shipment_id__accept_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Response"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Accept All","tags":["Transfer"]}}},"components":{"schemas":{"TransferInAcceptV2Response":{"description":"Aggregated results of accepting diamonds for transfer.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/TransferInAcceptV2DiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"TransferInAcceptV2Response","type":"object"},"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer In Reject All

> Reject inbound diamonds.\
> \
> Diamonds must not have been ACCEPTED in order to be rejected.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/reject/all":{"post":{"description":"Reject inbound diamonds.\n\nDiamonds must not have been ACCEPTED in order to be rejected.","operationId":"transfer_in_reject_all_v2_transfer_in__shipment_id__reject_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferInRejectDiamondResult"},"title":"Response Transfer In Reject All V2 Transfer In  Shipment Id  Reject All Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Reject All","tags":["Transfer"]}}},"components":{"schemas":{"TransferInRejectDiamondResult":{"description":"Returned by transfer/in/reject for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInRejectStatus"}},"required":["diamond_id","status"],"title":"TransferInRejectDiamondResult","type":"object"},"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer Out Start

> Create a new outbound shipment for a given group of rough diamonds.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/v2/transfer/out/start":{"post":{"description":"Create a new outbound shipment for a given group of rough diamonds.","operationId":"transfer_out_start_v2_transfer_out_start_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartResponse","anyOf":[{"$ref":"#/components/schemas/V2TransferOutStartErrorResponse"},{"$ref":"#/components/schemas/V2TransferOutStartResponse"}],"title":"Response Transfer Out Start V2 Transfer Out Start Post"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartErrorResponse"}}},"description":"Returned if:\n- Sender and receiver are the same participant.\n- Outbound shipment with the same name already exists.\n- Any of the diamond IDs passed in the request does not exist in the database.\n- Any of the diamond IDs passed in the request already belong to another shipment in the database.\n- Any of the diamond IDs passed in the request are locked.\n- Any of the diamond IDs passed is for a diamond which is not ROUGH.\n- Any of the diamond IDs passed is for a POLISHED diamond which has an in-flight data request.\n- Any of the diamond IDs passed is for a diamond which is not HELD.\n- Any of the diamond IDs passed is for a diamond which has a parent.\n- Any of the diamond IDs passed is for a diamond which is archived.\n"},"409":{"description":"Returned if any of the specified diamonds are being updated as part of another process."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Start","tags":["Transfer"]}}},"components":{"schemas":{"V2TransferOutStartRequest":{"description":"V2 of TransferOutStartRequest model, with shipment_type","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/PermissiveDiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"},"receiver":{"pattern":"^https://api\\..+\\.tracr\\.com$","title":"Receiver","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState"}},"required":["shipment_name","receiver","shipment_type","diamonds"],"title":"V2TransferOutStartRequest","type":"object"},"PermissiveDiamondIDOnly":{"description":"An object which contains only a diamond_id field.\n\nWe use a basic str as the type here to bypass pydantic validation\nthat would normally be run for the DiamondID type.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"PermissiveDiamondIDOnly","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"V2TransferOutStartResponse":{"description":"A response to a V2 transfer/out/start request.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"shipment_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_id","shipment_name","diamonds"],"title":"V2TransferOutStartResponse","type":"object"},"TransferOutValidateMissing":{"description":"Returned by the validate_diamonds_for_transfer function for a diamond that\ndoes not exist.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"status":{"const":"diamond_does_not_exist","default":"diamond_does_not_exist","title":"Status","type":"string"}},"required":["diamond_id"],"title":"TransferOutValidateMissing","type":"object"},"V2TransferOutValidatePolished":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"polished","default":"polished","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"$ref":"#/components/schemas/V2TransferOutPolishedFields"},"rough":{"title":"Rough","type":"null"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidatePolished","type":"object"},"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"},"V2TransferOutValidateRough":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"rough","default":"rough","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"title":"Polished","type":"null"},"rough":{"$ref":"#/components/schemas/V2TransferOutRoughFields"},"status":{"$ref":"#/components/schemas/TransferOutValidateRoughStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidateRough","type":"object"},"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"},"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"},"V2TransferOutStartErrorResponse":{"description":"Returns a list of all diamonds requested in the v2 /transfer/out/start\nendpoint and their corresponding statuses.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"message":{"title":"Message","type":"string"},"status":{"$ref":"#/components/schemas/V2TransferOutValidateStatus"}},"required":["diamonds","status","message"],"title":"V2TransferOutStartErrorResponse","type":"object"},"V2TransferOutValidateStatus":{"enum":["invalid","validated"],"title":"V2TransferOutValidateStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Transfer Out Cancel All

> Cancel outbound diamonds preventing them from being accepted.\
> \
> User initiated by the sender.\
> \
> Diamonds must not have been ACCEPTED in order to be cancelled.

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api.<id>.tracr.network"},{"description":"Sandbox","url":"https://api.<id>.uat.tracr.network"}],"paths":{"/v2/transfer/out/{shipment_id}/cancel/all":{"post":{"description":"Cancel outbound diamonds preventing them from being accepted.\n\nUser initiated by the sender.\n\nDiamonds must not have been ACCEPTED in order to be cancelled.","operationId":"transfer_out_cancel_all_v2_transfer_out__shipment_id__cancel_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferOutCancelDiamondResult"},"title":"Response Transfer Out Cancel All V2 Transfer Out  Shipment Id  Cancel All Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Cancel All","tags":["Transfer"]}}},"components":{"schemas":{"TransferOutCancelDiamondResult":{"description":"Returned by transfer/out/cancel for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferOutCancelStatus"}},"required":["diamond_id","status"],"title":"TransferOutCancelDiamondResult","type":"object"},"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tracr.com/api-reference/tracr-api/references/transfer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.