SalesChannelCargoCompany

Retrieve Cargo Company

get

Retrieves a specific cargo company associated with sales channel.

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200
Cargo company details
application/json
get
GET /api/v1/channel/{channel_id}/cargos/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "UPS",
  "erp_code": "UPS_001",
  "shipping_company": "yurtici",
  "created_date": "2025-06-27T08:46:54.993Z",
  "modified_date": "2025-06-27T08:46:54.993Z"
}

List Cargo Companies

get

Retrieves a list of cargo companies associated with sales channel.

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
pk__ininteger[]Optional

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

erp_code__exactstringOptional

Filter by exact ERP code.

Example: ERPCODE123
namestringOptional

Filters by name

shipping_companystring · enumOptional

Filter by shipping company enum

Possible values:
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
Responses
200
A list of cargo companies.
application/json
get
GET /api/v1/channel/{channel_id}/cargos/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-06-27T08:46:54.993Z",
      "modified_date": "2025-06-27T08:46:54.993Z"
    }
  ]
}
PreviousSalesChannelCancellationReasonsNextSalesChannelProductImage

Was this helpful?