Process Draft Consignment

This API is used to convert an existing draft consignment into a real consignment. As a result of the process, a shipping label is created and the consignment is sent to the carrier.

Endpoint Information

Process Flow

Draft Consignment (status: 24) → Process → Active Consignment (status: 2/3)
                                   ↓
                             Shipping Label Created

Request Parameters

URL Parameters

Body Parameters (Optional)

By sending body parameters in the process request, you can update and then process the draft. This way, both update and processing are done in a single request.

For available parameters, see the Create Draft Consignment page.

Example Usage

Process Only (Without Update)

If the draft is already complete, you can process with an empty body:

curl -X POST "{{BASE_URL}}/api/v1/consignments/draft/243/start-process" \
  -H "Content-Type: application/json" \
  -H "APIKEY: {{APIKEY}}"

<?php
$client = new \GuzzleHttp\Client();

$draftId = 243;

$response = $client->request('POST', "{{BASE_URL}}/api/v1/consignments/draft/{$draftId}/start-process", [
    'headers' => [
        'Content-Type' => 'application/json',
        'APIKEY' => '{{APIKEY}}'
    ]
]);

$body = json_decode($response->getBody(), true);

// Shipping label and tracking information
$barcode = $body['data']['barcode'];
$label = $body['data']['base64label'];

print_r($body);

<?php
$draftId = 243;

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "{{BASE_URL}}/api/v1/consignments/draft/{$draftId}/start-process",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'APIKEY: {{APIKEY}}'
    ]
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

// Shipping label and tracking information
$barcode = $result['data']['barcode'];

curl_close($ch);

Process + Update (Adding Package Information)

Processing by adding missing package information to the draft:

POST {{BASE_URL}}/api/v1/consignments/draft/243/start-process
Content-Type: application/json
APIKEY: {{APIKEY}}

{
    "packages": [
        {
            "package_type": 1,
            "post_type": 4,
            "weight": 2,
            "length": 30,
            "width": 20,
            "height": 15,
            "dangerous_goods": false,
            "items": [
                {
                    "description": "Bosch Coffee Machine",
                    "gtip": "851671900000",
                    "origin": "TR",
                    "currency_code": "EUR",
                    "quantity": 1,
                    "unit_price": 200
                }
            ]
        }
    ]
}

API Response

Successful Response

{
    "status": true,
    "message": "Draft Consignment process start successfully",
    "data": {
        "consignment": 243,
        "barcode": "C2H32972076995",
        "c2hBarcode": "C2H32972076995",
        "providerTrackingCode": "1Z999AA10123456784",
        "trackingUrl": "https://provider.com/track/1Z999AA10123456784",
        "contentType": "application/pdf",
        "base64label": "...base64_label_data..."
    }
}

Response Fields

Error Responses

{
    "status": false,
    "errors": [
        {
            "message": "Consignment not found or not in draft status"
        }
    ]
}

Common Error Scenarios

Next Steps

After successful processing:

1. Print Label: Decode the base64label field to print the label
2. Tracking: Track the consignment using trackingUrl or c2hBarcode
3. Webhook: Set up Webhook to receive status changes