---
title: "Request movements of credits in inventory"
method: POST
path: "/organizations/{id}/inventory/requests/{action}"
tags: ["Organizations"]
---

# Request movements of credits in inventory

`POST /organizations/{id}/inventory/requests/{action}`

## Request

- Base URL: `https://api.carbonregistry.com`
- URL: `https://api.carbonregistry.com/organizations/{id}/inventory/requests/{action}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/docs/organizations/:id/inventory/requests/:action/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint requests a specific action on credits in the organization's inventory

## Path parameters

- `action` 'transfer' | 'retire' | 'transfer_retire' | 'cancel' | 'issuance' | 'receive' | 'claim' | 'create_project' | 'create_vintages', required
- `id` string, required

## Headers

- `x-icr-api-version` string

## Request body

- CreditActionRequestDto
  - `creditId` string, required: The ID of the token credit
  - `amount` number, required: The amount of the token credit
  - `toOrganizationId` string: The ID of the organization receiving the token credit - if not provided, toAddress must be provided
  - `toAddress` string: The address of the organization receiving the token credit - if not provided, toOrganizationId must be provided
  - `retirementData` RetirementData
    - `reason` string, required: The reason for the retirement
    - `beneficiaryName` string, required: The beneficiary name
    - `comment` string, required: Comment for the retirement

## Response `200`

- ApiCreditRequestDto
  - `action` 'transfer' | 'retire' | 'transfer_retire' | 'cancel' | 'issuance' | 'receive' | 'claim' | 'create_project' | 'create_vintages', required: Action of the credit request
  - `type` 'exAnte' | 'exPost' | 'retirementCertificate', required: Type of the credit request
  - `id` string, required: ID of the credit request
  - `toAddress` string: Address of the recipient of the credit request
  - `createdAt` string, date-time, required: Timestamp of when the credit request was created
  - `updatedAt` string, date-time, required: Timestamp of when the credit request was last updated
  - `tokenId` string, required: ID of the token associated with the credit request
  - `tokenAddress` string, required: Address of the token associated with the credit request
  - `creditId` string, required: ID of the credit associated with the credit request
  - `serialization` string, required: Serialization of the credit request
  - `vintage` string, required: The vintage year of the credit
  - `amount` number, required: Amount of the credit request
  - `fromOrganizationId` string, required: ID of the organization sending the credit request
  - `toOrganizationId` string: ID of the organization receiving the credit request
  - `project` ApiProject, required
    - `id` string, required: The ID of the project
    - `fullName` string, required: The full name of the project
    - `url` string, required: The URL of the project
    - `publicUrl` string, required: The public URL of the project
    - `num` number, required: Project number. This is a unique identifier for the project
  - `txId` string: ID of the transaction associated with the credit request
  - `state` 'processed' | 'failed' | 'pending_queue' | 'pending_onchain' | 'pending_request' | 'rejected' | 'pending_reserved' | 'cancelled', required: State of the credit request: cancelled | failed | pending_onchain | pending_queue | pending_request | pending_reserved | processed | rejected
  - `transactionData` TransactionDataDto
    - `creditId` string, required: The id of the credit
    - `tokenId` string, required: The onchain token of the credit
    - `amount` number, required: The amount of this credit being moved
    - `serialization` string, required: The serialization of this credit
  - `retirementId` string: The retirement ID of the reservation
  - `retirementReason` string: Reason for retirement of the credit request
  - `retirementComment` string: Comment for retirement of the credit request
  - `beneficiaryName` string: Name of the beneficiary of the credit request

---

[API](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api.md) - [All operations](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/revisions/a9f1b102faca?raw)