Cargos

Retrieve cargo company

get

Get details of a specific cargo company by its ID.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cargo company retrieved successfully.

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Unique identifier of the cargo company.

Example: 1

namestring · max: 64Optional

Name of the cargo company.

Example: UPS

erp_codestring · max: 64Optional

Unique ERP code associated with the cargo company.

Example: UPS_001

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get/api/v1/cargos/{id}/

GET /api/v1/cargos/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "UPS",
  "erp_code": "UPS_001",
  "shipping_company": "yurtici",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

Update cargo company

put

Update an existing cargo company.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Input schema for creating or updating a cargo company record.

namestring · max: 64Required

Name of the cargo company.

erp_codestring · max: 64Required

ERP code used for identifying the cargo company in external systems.

shipping_companystring · enumRequired

Enum value indicating the shipping company type.

Example: yurticiPossible values:

Responses

200

Cargo company updated successfully.

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Unique identifier of the cargo company.

Example: 1

namestring · max: 64Optional

Name of the cargo company.

Example: UPS

erp_codestring · max: 64Optional

Unique ERP code associated with the cargo company.

Example: UPS_001

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put/api/v1/cargos/{id}/

PUT /api/v1/cargos/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "text",
  "erp_code": "text",
  "shipping_company": "yurtici"
}

{
  "pk": 1,
  "name": "UPS",
  "erp_code": "UPS_001",
  "shipping_company": "yurtici",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

Delete cargo company

delete

Delete a cargo permanently.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

No content

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

delete/api/v1/cargos/{id}/

DELETE /api/v1/cargos/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially update cargo company

patch

Partially update an existing cargo company.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Input schema for creating or updating a cargo company record.

namestring · max: 64Required

Name of the cargo company.

erp_codestring · max: 64Required

ERP code used for identifying the cargo company in external systems.

shipping_companystring · enumRequired

Enum value indicating the shipping company type.

Example: yurticiPossible values:

Responses

200

Cargo company partially updated successfully.

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Unique identifier of the cargo company.

Example: 1

namestring · max: 64Optional

Name of the cargo company.

Example: UPS

erp_codestring · max: 64Optional

Unique ERP code associated with the cargo company.

Example: UPS_001

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch/api/v1/cargos/{id}/

PATCH /api/v1/cargos/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "text",
  "erp_code": "text",
  "shipping_company": "yurtici"
}

{
  "pk": 1,
  "name": "UPS",
  "erp_code": "UPS_001",
  "shipping_company": "yurtici",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

List cargo companies

get

Retrieve a paginated list of all cargo companies with filtering support.

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

namestringOptional

Filter by name.

erp_codestringOptional

Filter by ERP code (contains)

Example: ERPCODE123

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

erp_code__exactstringOptional

Filter by exact ERP code.

Example: ERPCODE123

Responses

200

A paginated list of cargo companies.

application/json

countintegerOptional

Total number of cargo companies available.

nextstring · nullableOptional

URL of the next results page.

previousstring · nullableOptional

URL of the previous results page.

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get/api/v1/cargos/

GET /api/v1/cargos/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-01-01T00:00:00.000Z",
      "modified_date": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create cargo company

post

Create a new cargo company.

Authorizations

AuthorizationstringRequired

Body

Input schema for creating or updating a cargo company record.

namestring · max: 64Required

Name of the cargo company.

erp_codestring · max: 64Required

ERP code used for identifying the cargo company in external systems.

shipping_companystring · enumRequired

Enum value indicating the shipping company type.

Example: yurticiPossible values:

Responses

201

Cargo company created successfully.

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Unique identifier of the cargo company.

Example: 1

namestring · max: 64Optional

Name of the cargo company.

Example: UPS

erp_codestring · max: 64Optional

Unique ERP code associated with the cargo company.

Example: UPS_001

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post/api/v1/cargos/

POST /api/v1/cargos/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "text",
  "erp_code": "text",
  "shipping_company": "yurtici"
}

{
  "pk": 1,
  "name": "UPS",
  "erp_code": "UPS_001",
  "shipping_company": "yurtici",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

List Shipping Companies

get

Retrieve a list of all shipping companies.

Authorizations

AuthorizationstringRequired

Responses

200

Successfully retrieved available shipping companies.

application/json

get/api/v1/cargos/shipping_companies/

GET /api/v1/cargos/shipping_companies/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved available shipping companies.

{
  "shipping_companies": {
    "aras": "Aras Kargo",
    "ups": "UPS",
    "yurtici": "Yurtiçi Kargo",
    "mng": "MNG Kargo",
    "hbexpress": "Hepsi Express"
  }
}

Calculate cargo cost

post

Calculate the shipping cost for a given cargo request.

Authorizations

AuthorizationstringRequired

Body

shipping_companystring · enumRequired

The shipping company for which the cost will be calculated.

Example: yurticiPossible values:

Responses

200

Successfully calculated cargo cost.

application/json

shipping_pricenumber · floatOptional

The calculated shipping cost in the system's default currency.

post/api/v1/cargos/calculate_costs/

POST /api/v1/cargos/calculate_costs/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "shipping_company": "yurtici",
  "conf": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

Successfully calculated cargo cost.

{
  "shipping_price": 1
}