API docs by Redocly

Delta Cozum External API (1.0)

Download OpenAPI specification:

API Support: [email protected] URL: https://www.deltacozum.com License: Apache 2.0 Terms of Service

This is the external API for Delta Cozum customers.

Shipments

Create a manual shipment

Creates a new shipment order. Optionally returns PDF labels instead of ZPL if labelFormat is "pdf".

Authorizations:
BasicAuth
Request Body schema: application/json
required

Shipment Creation Payload

address
required
string
city
required
string
deliveryType
required
string (models.DeliveryType)
Enum: "HOME" "PICKUP"
district
required
string
email
string
labelFormat
string

"zpl" or "pdf"

name
required
string
paymentType
required
string (models.PaymentType)
Enum: "CASH" "COLLECT_ON_DELIVERY"
phoneNumber
string
quantity
required
integer >= 1
shipmentType
required
string (models.ShipmentType)
Enum: "STANDARD" "BUKOLI" "PUDO"
surname
required
string
transportType
required
string (models.TransportType)
Enum: "ROAD" "AIRPLANE" "MOTORBIKE_COURIER"
type
required
string (models.CargoType)
Enum: "FILE" "BOX" "ENVELOPE"
unitVolume
required
number >= 0.1

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "city": "string",
  • "deliveryType": "HOME",
  • "district": "string",
  • "email": "string",
  • "labelFormat": "string",
  • "name": "string",
  • "paymentType": "CASH",
  • "phoneNumber": "string",
  • "quantity": 1,
  • "shipmentType": "STANDARD",
  • "surname": "string",
  • "transportType": "ROAD",
  • "type": "FILE",
  • "unitVolume": 0.1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": true
}

Cancel shipment by Shipment ID

Cancels the shipment associated with the provided Shipment ID.

Authorizations:
BasicAuth
Request Body schema: application/json
required

Cancel Shipment Payload

shipmentId
required
integer

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "string",
  • "success": true
}

Cancel shipment by Order Number and Marketplace

Cancels the shipment associated with the provided Order Number and Marketplace.

Authorizations:
BasicAuth
Request Body schema: application/json
required

Cancel Shipment By Order Payload

marketplace
required
string
Enum: "TRENDYOL" "HEPSIBURADA" "N11"
orderNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "marketplace": "TRENDYOL",
  • "orderNumber": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "string",
  • "success": true
}

Get shipment labels

Retrieve the shipment labels (ZPL or PDF) via Shipment ID or Order Number and Marketplace.

Authorizations:
BasicAuth
Request Body schema: application/json
required

Get Shipment Label Payload

labelFormat
string
Enum: "zpl" "pdf"

Default "zpl"

marketplace
string
Enum: "TRENDYOL" "HEPSIBURADA" "N11"
orderNumber
string
shipmentId
integer

Responses

Request samples

Content type
application/json
{
  • "labelFormat": "zpl",
  • "marketplace": "TRENDYOL",
  • "orderNumber": "string",
  • "shipmentId": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": true
}

Create shipment directly from marketplace order number

Syncs the order if not exists, creates a shipment with given volume and quantity, and returns the label.

Authorizations:
BasicAuth
Request Body schema: application/json
required

Marketplace Shipment Payload

labelFormat
string
Enum: "zpl" "pdf"

"zpl" or "pdf"

marketplace
required
string
Enum: "TRENDYOL" "HEPSIBURADA" "N11"
orderNumber
required
string
printProductInfo
boolean

Default true

quantity
required
integer >= 1
unitVolume
required
number >= 0.1

Responses

Request samples

Content type
application/json
{
  • "labelFormat": "zpl",
  • "marketplace": "TRENDYOL",
  • "orderNumber": "string",
  • "printProductInfo": true,
  • "quantity": 1,
  • "unitVolume": 0.1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": true
}

Get shipment status

Retrieve the current status of a shipment via Shipment ID or Order Number and Marketplace.

Authorizations:
BasicAuth
Request Body schema: application/json
required

Get Shipment Status Payload

marketplace
string
Enum: "TRENDYOL" "HEPSIBURADA" "N11"
orderNumber
string
shipmentId
integer

Responses

Request samples

Content type
application/json
{
  • "marketplace": "TRENDYOL",
  • "orderNumber": "string",
  • "shipmentId": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": true
}

Authentication

Validate API Key

Validates the Basic Auth credentials and returns basic customer information.

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": true
}