Transfer

Transfer In Reject

post

/transfer/in/{shipment_id}/reject

Reject inbound diamonds.

Diamonds must not have been ACCEPTED in order to be rejected.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Bodyobject · DiamondIDOnly[]

An object which contains only a diamond_id field.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Returned by transfer/in/reject for each diamond.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

statusstring · enumRequired

Represents the result of a transfer-in-reject operation.

Possible values:

422

Validation Error

application/json

post/transfer/in/{shipment_id}/reject

POST /transfer/in/{shipment_id}/reject HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 44

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
  }
]

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
    "status": "success"
  }
]

Transfer Out Cancel

post

/transfer/out/{shipment_id}/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.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Bodyobject · DiamondIDOnly[]

An object which contains only a diamond_id field.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Returned by transfer/out/cancel for each diamond.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

statusstring · enumRequired

Represents the result of a transfer-out-cancel operation.

Possible values:

422

Validation Error

application/json

post/transfer/out/{shipment_id}/cancel

POST /transfer/out/{shipment_id}/cancel HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 44

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
  }
]

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
    "status": "success"
  }
]

Transfer In Accept

post

/v2/transfer/in/{shipment_id}/accept

Accept an inbound shipment of diamonds.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Body

A list of diamonds to accept for transfer.

Responses

200

Successful Response

application/json

Aggregated results of accepting diamonds for transfer.

422

Validation Error

application/json

post/v2/transfer/in/{shipment_id}/accept

POST /v2/transfer/in/{shipment_id}/accept HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "diamonds": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
    }
  ]
}

{
  "results": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "status": "success"
    }
  ]
}

Transfer In Accept All

post

/v2/transfer/in/{shipment_id}/accept/all

Accept all the diamonds in the inbound shipment.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Aggregated results of accepting diamonds for transfer.

422

Validation Error

application/json

post/v2/transfer/in/{shipment_id}/accept/all

POST /v2/transfer/in/{shipment_id}/accept/all HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "results": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "status": "success"
    }
  ]
}

Transfer In Reject All

post

/v2/transfer/in/{shipment_id}/reject/all

Reject inbound diamonds.

Diamonds must not have been ACCEPTED in order to be rejected.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Returned by transfer/in/reject for each diamond.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

statusstring · enumRequired

Represents the result of a transfer-in-reject operation.

Possible values:

422

Validation Error

application/json

post/v2/transfer/in/{shipment_id}/reject/all

POST /v2/transfer/in/{shipment_id}/reject/all HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
    "status": "success"
  }
]

Transfer Out Start

post

/v2/transfer/out/start

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

Body

V2 of TransferOutStartRequest model, with shipment_type

receiverstringRequiredPattern: ^https://api\..+\.tracr\.com$

shipment_namestringRequired

shipment_typestring · enumRequired

The different diamond lifecycle states that can be transferred (unique per shipment).

Possible values:

Responses

200

Successful Response

application/json

A response to a V2 transfer/out/start request.

400

Returned if:

Sender and receiver are the same participant.
Outbound shipment with the same name already exists.
Any of the diamond IDs passed in the request does not exist in the database.
Any of the diamond IDs passed in the request already belong to another shipment in the database.
Any of the diamond IDs passed in the request are locked.
Any of the diamond IDs passed is for a diamond which is not ROUGH.
Any of the diamond IDs passed is for a POLISHED diamond which has an in-flight data request.
Any of the diamond IDs passed is for a diamond which is not HELD.
Any of the diamond IDs passed is for a diamond which has a parent.
Any of the diamond IDs passed is for a diamond which is archived.

application/json

409

Returned if any of the specified diamonds are being updated as part of another process.

422

Validation Error

application/json

post/v2/transfer/out/start

POST /v2/transfer/out/start HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "diamonds": [
    {
      "diamond_id": "text"
    }
  ],
  "receiver": "text",
  "shipment_name": "text",
  "shipment_type": "rough"
}

{
  "diamonds": [
    {
      "diamond_id": "text",
      "status": "diamond_does_not_exist"
    }
  ],
  "shipment_id": "e1mv3nn4n10kd1lw6mde6sums",
  "shipment_name": "text",
  "message": "text",
  "status": "invalid"
}

Transfer Out Cancel All

post

/v2/transfer/out/{shipment_id}/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.

Path parameters

shipment_idstringRequired

ID of the shipment assigned by Tracr

Example: 5l0o4eixnuubtg51fouym73rnPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Returned by transfer/out/cancel for each diamond.

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

statusstring · enumRequired

Represents the result of a transfer-out-cancel operation.

Possible values:

422

Validation Error

application/json

post/v2/transfer/out/{shipment_id}/cancel/all

POST /v2/transfer/out/{shipment_id}/cancel/all HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

[
  {
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
    "status": "success"
  }
]

PreviousDiamonds NextShipments

Last updated 23 days ago