Shipments

List inbound shipments

get

/v2/shipment/inbound

Return all inbound shipments matching the filters defined by the query parameters.

Query parameters

created_at__gtestring · date-timeOptional

Filter to shipments created on or after the given timestamp. Must be an ISO-8601 compliant timestamp.

created_at__ltstring · date-timeOptional

Filter to shipments created after the before timestamp. Must be an ISO-8601 compliant timestamp.

id__instringOptional

Filter to shipments with the given shipment IDs.

namestringOptional

Filter to shipments with an exact match on the given name.

name__containsstringOptional

Filter to shipments where the name contains the given value (case sensitive).

name__icontainsstringOptional

Filter to shipments where the name contains the given value (case insensitive).

shipment_typestring · enumOptional

Filter to shipments with the given shipment type.

Possible values:

searchstringOptional

Unified search for shipments. This will return any shipments where the given value is contained within their name, ID, or sender.

order_bystringOptionalDefault: created_at,id

senderstringOptional

Filter to shipments with an exact match on the given sender.

sender__containsstringOptional

Filter to shipments where the sender contains the given value (case sensitive).

sender__icontainsstringOptional

Filter to shipments where the sender contains the given value.(case sensitive).

statusstring · enumOptional

Filter to shipments with the given status.

Possible values:

status__instringOptional

Filter to shipments with the given status.

diamonds__diamond_idstringOptional

The diamond's globally unique Tracr ID.

diamonds__diamond_id__instringOptional

The diamond's globally unique Tracr ID.

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 1000OptionalDefault: 100

Responses

200

Successful Response

application/json

A paginated response containing zero or more inbound shipments.

nextstring · nullableOptional

The URL for the next page.

pageinteger · min: 1 · nullableRequired

The number of the current page.

pagesinteger · nullableOptional

The total number of pages.

previousstring · nullableOptional

The URL of the previous page.

totalintegerRequired

The total number of results across all pages.

422

Validation Error

application/json

get/v2/shipment/inbound

GET /v2/shipment/inbound HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "next": "text",
  "page": 1,
  "pages": 1,
  "previous": "text",
  "results": [
    {
      "created_at": "2026-08-08T00:53:34.060Z",
      "diamonds": [
        {
          "created_at": "2026-08-08T00:53:34.060Z",
          "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
          "lifecycle_state": "rough",
          "polished": {
            "carats": "text",
            "clarity": "FL",
            "colour": "text",
            "cut_grade": "I",
            "inscription_numbers": [
              "text"
            ],
            "report_numbers": [
              "text"
            ],
            "shape": "Asscher"
          },
          "rough": {
            "box_id": "text",
            "carats": "text",
            "colour": "text",
            "model": "text",
            "quality": "text",
            "sight_number": 1,
            "sight_year": 1,
            "stress": "text"
          },
          "transfer_state": "accepted",
          "updated_at": "2026-08-08T00:53:34.060Z"
        }
      ],
      "id": "text",
      "name": "text",
      "sender": "text",
      "shipment_type": "rough",
      "status": "action_required",
      "total_diamonds": 1
    }
  ],
  "total": 1
}

Get inbound shipment filters

get

/v2/shipment/inbound/filter

Return the discrete filter values that can be used to filter inbound shipments.

Responses

200

Successful Response

application/json

Dynamically populated values for inbound shipment filters.

get/v2/shipment/inbound/filter

GET /v2/shipment/inbound/filter HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

200

Successful Response

{
  "shipment_type": [
    "rough"
  ],
  "status": [
    "action_required"
  ]
}

Get inbound shipment

get

/v2/shipment/inbound/{shipment_id}

Retrieve the details of a given inbound shipment.

Path parameters

shipment_idstringRequired

The ID of the shipment to return.

Responses

200

Successful Response

application/json

A response containing a single inbound shipment.

created_atstring · date-timeRequired

The time at which this Tracr instance was first notified of the shipment.

idstringRequired

The shipment's globally unique identifier.

namestringRequired

The shipment's name, populated by the sender.

senderstringRequired

The API URL of the participant who created this shipment.

shipment_typestring · enumRequired

Whether the shipment contains rough or polished diamonds.

Possible values:

statusstring · enumRequired

Aggregated status of the diamonds within a shipment.

Possible values:

total_diamondsintegerRequired

The total number of diamonds in the shipment. This can be larger than the count of diamonds in the shipment if the shipment is still being received.

422

Validation Error

application/json

get/v2/shipment/inbound/{shipment_id}

GET /v2/shipment/inbound/{shipment_id} HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "created_at": "2026-08-08T00:53:34.060Z",
  "diamonds": [
    {
      "created_at": "2026-08-08T00:53:34.060Z",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "lifecycle_state": "rough",
      "polished": {
        "carats": "text",
        "clarity": "FL",
        "colour": "text",
        "cut_grade": "I",
        "inscription_numbers": [
          "text"
        ],
        "report_numbers": [
          "text"
        ],
        "shape": "Asscher"
      },
      "rough": {
        "box_id": "text",
        "carats": "text",
        "colour": "text",
        "model": "text",
        "quality": "text",
        "sight_number": 1,
        "sight_year": 1,
        "stress": "text"
      },
      "transfer_state": "accepted",
      "updated_at": "2026-08-08T00:53:34.060Z"
    }
  ],
  "id": "text",
  "name": "text",
  "sender": "text",
  "shipment_type": "rough",
  "status": "action_required",
  "total_diamonds": 1
}

List outbound shipments

get

/v2/shipment/outbound

Return all outbound shipments matching the filters defined by the query parameters.

Query parameters

created_at__gtestring · date-timeOptional

Filter to shipments created on or after the given timestamp. Must be an ISO-8601 compliant timestamp.

created_at__ltstring · date-timeOptional

Filter to shipments created after the before timestamp. Must be an ISO-8601 compliant timestamp.

id__instringOptional

Filter to shipments with the given shipment IDs.

namestringOptional

Filter to shipments with an exact match on the given name.

name__containsstringOptional

Filter to shipments where the name contains the given value (case sensitive).

name__icontainsstringOptional

Filter to shipments where the name contains the given value (case insensitive).

shipment_typestring · enumOptional

Filter to shipments with the given shipment type.

Possible values:

searchstringOptional

Unified search for shipments. This will return any shipments where the given value is contained within their name, ID, or recipient.

order_bystringOptionalDefault: created_at,id

receiverstringOptional

Filter to shipments with an exact match on the given receiver.

receiver__containsstringOptional

Filter to shipments where the receiver contains the given value (case sensitive).

receiver__icontainsstringOptional

Filter to shipments where the receiver contains the given value.(case sensitive).

statusstring · enumOptional

Filter to shipments with the given status.

Possible values:

status__instringOptional

Filter to shipments with the given status.

diamonds__diamond_idstringOptional

The diamond's globally unique Tracr ID.

diamonds__diamond_id__instringOptional

The diamond's globally unique Tracr ID.

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 1000OptionalDefault: 100

Responses

200

Successful Response

application/json

A paginated response containing zero or more outbound shipments.

nextstring · nullableOptional

The URL for the next page.

pageinteger · min: 1 · nullableRequired

The number of the current page.

pagesinteger · nullableOptional

The total number of pages.

previousstring · nullableOptional

The URL of the previous page.

totalintegerRequired

The total number of results across all pages.

422

Validation Error

application/json

get/v2/shipment/outbound

GET /v2/shipment/outbound HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "next": "text",
  "page": 1,
  "pages": 1,
  "previous": "text",
  "results": [
    {
      "created_at": "2026-08-08T00:53:34.060Z",
      "diamonds": [
        {
          "created_at": "2026-08-08T00:53:34.060Z",
          "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
          "lifecycle_state": "rough",
          "participant_id": "text",
          "polished": {
            "carats": "text",
            "clarity": "FL",
            "colour": "D",
            "cut_grade": "I",
            "display_colour": "text",
            "inscription_numbers": [
              "text"
            ],
            "report_numbers": [
              "text"
            ],
            "shape": "Asscher"
          },
          "rough": {
            "box_id": "text",
            "carats": "text",
            "colour": "text",
            "display_colour": "text",
            "model": "text",
            "quality": "text",
            "sight_number": 1,
            "sight_year": 1,
            "stress": "text"
          },
          "transfer_state": "accepted",
          "updated_at": "2026-08-08T00:53:34.060Z"
        }
      ],
      "id": "text",
      "name": "text",
      "receiver": "text",
      "shipment_type": "rough",
      "status": "accepting"
    }
  ],
  "total": 1
}

Get outbound shipment filters

get

/v2/shipment/outbound/filter

Return the discrete filter values that can be used to filter outbound shipments.

Responses

200

Successful Response

application/json

Dynamically populated values for outbound shipment filters.

get/v2/shipment/outbound/filter

GET /v2/shipment/outbound/filter HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

200

Successful Response

{
  "shipment_type": [
    "rough"
  ],
  "status": [
    "accepting"
  ]
}

Get outbound shipment

get

/v2/shipment/outbound/{shipment_id}

Retrieve the details of a given outbound shipment.

Path parameters

shipment_idstringRequired

The ID of the shipment to fetch.

Responses

200

Successful Response

application/json

A response containing a single outbound shipment.

created_atstring · date-timeRequired

The time at which the shipment was created.

idstringRequired

The shipment's globally unique identifier.

namestringRequired

The shipment's name.

receiverstringRequired

The API URL of the participant to whom this shipment will be sent.

shipment_typestring · enumRequired

Whether the shipment contains rough or polished diamonds.

Possible values:

statusstring · enumRequired

Aggregated status of the diamonds within a shipment.

Possible values:

422

Validation Error

application/json

get/v2/shipment/outbound/{shipment_id}

GET /v2/shipment/outbound/{shipment_id} HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "created_at": "2026-08-08T00:53:34.060Z",
  "diamonds": [
    {
      "created_at": "2026-08-08T00:53:34.060Z",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "lifecycle_state": "rough",
      "participant_id": "text",
      "polished": {
        "carats": "text",
        "clarity": "FL",
        "colour": "D",
        "cut_grade": "I",
        "display_colour": "text",
        "inscription_numbers": [
          "text"
        ],
        "report_numbers": [
          "text"
        ],
        "shape": "Asscher"
      },
      "rough": {
        "box_id": "text",
        "carats": "text",
        "colour": "text",
        "display_colour": "text",
        "model": "text",
        "quality": "text",
        "sight_number": 1,
        "sight_year": 1,
        "stress": "text"
      },
      "transfer_state": "accepted",
      "updated_at": "2026-08-08T00:53:34.060Z"
    }
  ],
  "id": "text",
  "name": "text",
  "receiver": "text",
  "shipment_type": "rough",
  "status": "accepting"
}

PreviousTransfer NextModels

Last updated 23 days ago