> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agribackup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unlink Batch from Shipment EVM Rollback | AgriBackup

> Asynchronously roll back the Hedera smart contract lock to free a batch from a cancelled shipment. Returns 202 Accepted with a jobId.

Asynchronously rolls back the Hedera smart contract lock that binds a batch to a specific shipment, freeing the batch for reassignment to a new shipment. This operation is essential for logistics cancellations or port-level diversions where a new Bill of Lading must be issued. Because the EVM rollback requires Hedera consensus, the endpoint returns `202 Accepted` immediately with a `jobId`. Poll `GET /api/v1/enterprise/eudr/jobs/{jobId}` to confirm the rollback has completed before attempting to re-link the batch.

<Warning>
  This operation cannot be performed on batches that have already been submitted to TRACES NT. Contact AgriBackup support if you need to revoke a submitted Due Diligence Statement.
</Warning>

## Request Headers

| Header            | Required | Description                                                                                                              |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `X-API-Key`       | ✅        | Your live API key, e.g. `sk_live_...`.                                                                                   |
| `Idempotency-Key` | ✅        | A UUID v4 string. Replaying the same key within 24 hours returns the original response without re-invoking the rollback. |

## Path Parameters

| Parameter    | Type   | Required | Description                                        |
| ------------ | ------ | -------- | -------------------------------------------------- |
| `batchId`    | string | ✅        | The UUID of the EUDR batch to unlink.              |
| `shipmentId` | string | ✅        | The shipment reference ID to remove the link from. |

## Response — 202 Accepted

| Field                  | Type              | Description                                                                         |
| ---------------------- | ----------------- | ----------------------------------------------------------------------------------- |
| `jobId`                | string            | Use this ID to poll rollback status via `GET /api/v1/enterprise/eudr/jobs/{jobId}`. |
| `status`               | string            | Always `PENDING` on acceptance.                                                     |
| `estimatedDurationSec` | integer           | Estimated seconds until the Hedera rollback transaction reaches consensus.          |
| `createdAt`            | string (ISO-8601) | Timestamp when the job was accepted.                                                |

```json theme={null}
{
  "jobId": "job_998877",
  "status": "PENDING",
  "estimatedDurationSec": 3,
  "createdAt": "2026-06-15T12:00:00Z"
}
```

## Error Responses

| Status | Meaning                                                                       |
| ------ | ----------------------------------------------------------------------------- |
| `400`  | Invalid `batchId` or `shipmentId`.                                            |
| `401`  | Missing or invalid `X-API-Key`.                                               |
| `403`  | The batch has been submitted to TRACES NT and the link cannot be rolled back. |
| `404`  | No active link found between the given `batchId` and `shipmentId`.            |

## Code Examples

<CodeGroup>
  ```python Python theme={null}
  import agribackup
  from agribackup.rest import ApiException
  import uuid

  configuration = agribackup.Configuration(host="https://live.agribackup.com/api/v1")
  configuration.api_key['ApiKeyAuth'] = 'sk_live_YOUR_API_KEY'

  with agribackup.ApiClient(configuration) as api_client:
      try:
          api_instance = agribackup.EnterpriseLogisticsApi(api_client)

          response = api_instance.unlink_shipment(
              idempotency_key=str(uuid.uuid4()),
              batch_id='uuid-1234',
              shipment_id='SHIP-OOCL-9988'
          )
          print("Rollback job accepted:", response.job_id)
      except ApiException as e:
          print("Error:", e)
  ```

  ```javascript Node.js theme={null}
  import { AgriBackupClient } from '@agribackup/sdk';
  import { v4 as uuidv4 } from 'uuid';

  const client = new AgriBackupClient({
    apiKey: 'sk_live_YOUR_API_KEY',
    baseUrl: 'https://live.agribackup.com/api/v1'
  });

  async function unlinkShipment(batchId, shipmentId) {
    try {
      const response = await client.logistics.unlinkShipment({
        idempotencyKey: uuidv4(),
        batchId,
        shipmentId
      });
      console.log('Rollback job accepted:', response.jobId);
    } catch (error) {
      console.error('Error:', error.message);
    }
  }

  unlinkShipment('uuid-1234', 'SHIP-OOCL-9988');
  ```

  ```bash cURL theme={null}
  curl -X DELETE \
    "https://live.agribackup.com/api/v1/enterprise/eudr/shipments/uuid-1234/shipment/SHIP-OOCL-9988" \
    -H "X-API-Key: sk_live_YOUR_API_KEY" \
    -H "Idempotency-Key: $(uuidgen)"
  ```
</CodeGroup>


## OpenAPI

````yaml delete /api/v1/enterprise/eudr/shipments/{batchId}/shipment/{shipmentId}
openapi: 3.0.1
info:
  title: AgriBackup Enterprise EUDR API
  description: >-
    # Introduction


    AgriBackup is the cryptographic compliance engine for EU-bound commodity
    imports. Built on Deterministic Logic, Immutable Evidence, and
    High-Throughput Ingestion, our API provides Tier-1 enterprise routing for EU
    Deforestation Regulation (EUDR).


    ## The Integration Vector

    To integrate this Digital Trust Layer into your ERP, you must execute the
    following sequence:

    1. **Authentication:** Generate your `X-API-Key` from the client dashboard.

    2. **Telemetry:** Register your webhook URLs via `POST /webhooks`.

    3. **Ingestion:** Push your GeoJSON polygons via `POST /polygons`.

    4. **Logistics:** Lock the batch to a shipment via `POST /shipments/link`.


    ## Asynchronous Architecture

    Because satellite deforestation screening and Hedera DLT anchoring take
    time, ingestion endpoints return a `202 Accepted`. You must listen for the
    corresponding Webhook to confirm cryptographic execution.


    ## Base URLs

    * **Production:** `https://live.agribackup.com`

    * **Sandbox:** `https://sandbox.agribackup.com`
  contact:
    name: AgriBackup Architecture Team
    url: https://agribackup.com
    email: contact@agribackup.com
  license:
    name: Proprietary
    url: https://agribackup.com/terms
  version: v1.0
servers:
  - url: https://live.agribackup.com
    description: Production (Mainnet)
  - url: https://sandbox.agribackup.com
    description: Sandbox (Testnet)
security: []
tags:
  - name: Enterprise Risk Management
  - name: Enterprise Clearance Webhooks
    description: Asynchronous status receivers for TRACES NT
  - name: Enterprise Jobs
    description: Query status and metrics of asynchronous compliance jobs
  - name: Enterprise Suppliers
  - name: Enterprise Diagnostics
    description: Monitor API health, consensus ledger, and satellite systems availability
  - name: Enterprise Suppliers
    description: Map internal ERP vendor IDs to EU Operator UUIDs
  - name: Enterprise Webhooks
    description: Register endpoints for asynchronous compliance events
  - name: Enterprise Archival
    description: Endpoints for bulk compliance archiving and auditor extensibility
  - name: Enterprise Logistics
    description: Smart contract linking of batches to logistics shipments
  - name: Enterprise Declarations
    description: DDS generation with legal land tenure proofs
  - name: Enterprise Batches
  - name: Enterprise API Keys
  - name: Enterprise Diagnostics
  - name: Enterprise Logistics
  - name: Enterprise Jobs
  - name: Enterprise Evidence
    description: Cryptographic evidence ledger anchored on Hedera Hashgraph
  - name: Enterprise Declarations
  - name: Enterprise Credentials
  - name: Enterprise Evidence
  - name: Enterprise Risk Management
    description: Pre-assessment of country risk and satellite deforestation probabilities
  - name: Enterprise Batches
    description: Programmatic batch ingestion and management
  - name: Enterprise Polygons
  - name: Introduction
  - name: Enterprise Polygons
    description: Programmatic polygon ingestion and verification
  - name: Enterprise Archival
  - name: Enterprise Credentials
    description: Programmatic ingestion of vault-secured enterprise secrets
  - name: Enterprise API Keys
    description: Endpoints for managing B2B API Keys (Requires standard JWT login)
  - name: Enterprise Webhooks
paths:
  /api/v1/enterprise/eudr/shipments/{batchId}/shipment/{shipmentId}:
    delete:
      tags:
        - Enterprise Logistics
      summary: Unlink a Batch from a Shipment (EVM Rollback)
      description: >-
        Asynchronously rollback the Hedera smart contract lock, freeing the
        batch for reassignment. Essential for logistics cancellations at the
        port.
      operationId: unlinkShipment
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/IdempotencyKey'
          name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
        - name: batchId
          in: path
          required: true
          schema:
            type: string
        - name: shipmentId
          in: path
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Smart contract unlock initiated asynchronously
          headers:
            X-RateLimit-Limit:
              description: >-
                The maximum number of requests you're permitted to make per
                hour.
              schema:
                type: integer
                format: int32
            X-RateLimit-Remaining:
              description: >-
                The number of requests remaining in the current rate limit
                window.
              schema:
                type: integer
                format: int32
            X-RateLimit-Reset:
              description: >-
                The time at which the current rate limit window resets in UTC
                epoch seconds.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobAcceptedResponse'
        '400':
          description: Bad Request (e.g., Invalid Batch ID)
          headers:
            X-RateLimit-Limit:
              description: >-
                The maximum number of requests you're permitted to make per
                hour.
              schema:
                type: integer
                format: int32
            X-RateLimit-Remaining:
              description: >-
                The number of requests remaining in the current rate limit
                window.
              schema:
                type: integer
                format: int32
            X-RateLimit-Reset:
              description: >-
                The time at which the current rate limit window resets in UTC
                epoch seconds.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Python
          source: >-
            import agribackup

            from agribackup.rest import ApiException


            # Initialize Client

            configuration =
            agribackup.Configuration(host="https://live.agribackup.com/api/v1")

            configuration.api_key['ApiKeyAuth'] = 'sk_live_YOUR_API_KEY'


            with agribackup.ApiClient(configuration) as api_client:
                try:
                    api_instance = agribackup.EnterpriseLogisticsApi(api_client)
                    response = api_instance.unlink_shipment()
                    print(response)
                except ApiException as e:
                    print("Exception when calling API: %s\n" % e)
        - lang: Node.js
          source: |-
            import { AgriBackupClient } from '@agribackup/sdk';

            // Initialize Client
            const client = new AgriBackupClient({
              apiKey: 'sk_live_YOUR_API_KEY',
              baseUrl: 'https://live.agribackup.com/api/v1'
            });

            async function execute() {
              try {
                const response = await client.logistics.unlinkShipment();
                console.log(response);
              } catch (error) {
                console.error(error);
              }
            }
        - lang: Java
          source: |-
            import com.agribackup.client.*;
            import com.agribackup.client.api.*;
            import com.agribackup.client.model.*;

            public class Example {
                public static void main(String[] args) {
                    ApiClient defaultClient = Configuration.getDefaultApiClient();
                    defaultClient.setBasePath("https://live.agribackup.com/api/v1");
                    defaultClient.setApiKey("sk_live_YOUR_API_KEY");

                    EnterpriseLogisticsApi apiInstance = new EnterpriseLogisticsApi(defaultClient);
                    try {
                        Object result = apiInstance.unlinkShipment();
                        System.out.println(result);
                    } catch (ApiException e) {
                        System.err.println("Exception when calling API: " + e.getResponseBody());
                    }
                }
            }
        - lang: C#
          source: |-
            using System;
            using System.Threading.Tasks;
            using AgriBackup.SDK.Api;
            using AgriBackup.SDK.Client;
            using AgriBackup.SDK.Model;

            class Program {
                static async Task Main() {
                    Configuration config = new Configuration();
                    config.BasePath = "https://live.agribackup.com/api/v1";
                    config.AddApiKey("ApiKeyAuth", "sk_live_YOUR_API_KEY");

                    var apiInstance = new EnterpriseLogisticsApi(config);
                    try {
                        var result = await apiInstance.UnlinkShipmentAsync();
                        Console.WriteLine(result);
                    } catch (ApiException e) {
                        Console.WriteLine("Exception when calling API: " + e.Message);
                    }
                }
            }
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Unique idempotency key (UUID) to prevent duplicate operations. Safely
        stored in Redis with a strict 24-hour TTL to prevent memory bloat during
        saturation attacks.
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    JobAcceptedResponse:
      required:
        - createdAt
        - estimatedDurationSec
        - jobId
        - status
      type: object
      properties:
        jobId:
          type: string
          description: The unique asynchronous tracking job ID
          example: job_998877
        status:
          type: string
          description: Current execution status invariant
          example: PENDING
          enum:
            - PENDING
        estimatedDurationSec:
          type: integer
          description: >-
            Estimated duration in seconds before consensus or processing lock
            release
          format: int32
          example: 3
        createdAt:
          type: string
          description: Timestamp when the job was accepted
          format: date-time
          example: '2026-06-15T12:00:00Z'
      description: Response payload for asynchronously accepted jobs
    ApiError:
      required:
        - code
        - details
        - message
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: VALIDATION_FAILED
        message:
          type: string
          description: Human-readable error message
          example: Invalid polygon coordinates
        details:
          type: array
          description: Detailed list of validation errors, if applicable
          items:
            $ref: '#/components/schemas/ApiErrorDetail'
      description: Standard error format for all Enterprise API failures
    ApiErrorDetail:
      required:
        - code
        - field
        - issue
      type: object
      properties:
        code:
          type: string
          description: Programmatic error code for automated branch logic
          example: INVALID_COORDINATE_CLOSURE
        field:
          type: string
          description: The field or property that caused the error
          example: features[0].properties.area
        issue:
          type: string
          description: A description of the issue with the field
          example: Area must be specified in hectares and cannot be negative
      description: Detailed error information for a specific field
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Enterprise API Key provided via the AgriBackup developer console.
      name: X-API-Key
      in: header

````