Organization warehouse

Cancel warehouse reservation

This endpoint cancels a specific warehouse reservation. If the reservation is active the credits will be immediately made available in the organization's warehouse.

delete/organizations/{id}/warehouse/inventory/reservations/{reservationId}

Path parameters

idstring required

reservationIdstring required

Headers

x-icr-api-versionstring

API version

Response

idstring required

The unique identifier of the reservation, used to finish / cancel it

creditIdstring required

The unique identifier of the credit

serializationstring required

The serialization of the reservation

amountnumber required

The amount reserved

createdAtstring date-time required

The creation date of the reservation

statestring required

The state of the reservation - if undefined the reservation is still waiting to be actived / finished.

retirementIdstring

The retirement ID of the reservation

updatedAtstring date-time required

The update date of the reservation

tokenIdstring required

The token ID of the reservation

tokenAddressstring required

The token address of the reservation

type'exPost' | 'exAnte' required

The type of the reservation

reservedToDatestring date-time required

The reserved to date of the reservation

isCompleteboolean required

The completion status of the reservation

Example response

{
  "id": "d449c665-3100-40c6-91ad-9d3f0a9fd343",
  "creditId": "exPost-2-0x51298f2f1142ecb129a2db5e6afd24f34f2e53f1",
  "serialization": "ICR-ISL-354-78040-14-R-0-2021",
  "amount": 10,
  "createdAt": "2022-01-01T00:00:00Z",
  "state": "pending",
  "retirementId": "1",
  "updatedAt": "2022-01-01T00:00:00Z",
  "tokenId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenAddress": "0x123456789abcdef",
  "type": "exPost",
  "reservedToDate": "2022-01-01T00:00:00Z",
  "isComplete": true,
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fullName": "Project 1",
    "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e"
  },
  "reserver": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Reserver 1"
  }
}